| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> |
| |
| <title>Redback :: Integration :: REST :: Api: UserService</title> |
| |
| <!-- Mobile viewport optimized: j.mp/bplateviewport --> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <!-- Bootstrap core CSS --> |
| <!-- <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css"> --> |
| |
| <!--custom css for these pages--> |
| <link rel="stylesheet" href="css/style.css"> |
| |
| <link href="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/prettify.css" type="text/css"> |
| |
| <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> |
| <!--[if lt IE 9]> |
| <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script> |
| <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> |
| <![endif]--> |
| </head> |
| |
| <body class="home"> |
| <div class="container"> |
| <header> |
| |
| <div id="header" class="column first last span-20"> |
| <div id="site-name" class="column span-18 append-1 prepend-1 first last"><a href="index.html">Redback :: Integration :: REST :: Api: UserService</a></div> |
| <div id="primary" class="column span-18 append-1 prepend-1 first last"> |
| <ul class="navigation"> |
| <li id="nav-rest"><a href="resources.html">REST</a></li> |
| <li id="nav-data"><a href="data.html">Data Model</a></li> |
| </ul> |
| </div> |
| <div> |
| <ul class="xbreadcrumbs" id="breadcrumbs"> |
| <li> |
| <a href="index.html" class="home">Home</a> > |
| |
| </li> |
| <li> |
| <a href="resources.html">Resources</a> > |
| |
| </li> |
| <li class="current"> |
| <a href="resource_UserService.html">UserService</a> |
| |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!--<nav class="navbar navbar-inverse navbar-fixed-top"> |
| <div class="container-fluid"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <a class="navbar-brand" href="index.html">Redback :: Integration :: REST :: Api: UserService</a> |
| </div> |
| <div id="navbar" class="navbar-collapse collapse"> |
| <ul class="nav navbar-nav navbar-right"> |
| <li><a href="resources.html">Resources</a></li> |
| <li><a href="data.html">Data Types</a></li> |
| <li><a href="downloads.html">Files and Libraries</a></li> |
| </ul> |
| </div> |
| </div> |
| </nav>--> |
| </header> |
| <div id="main" class="column first last span-20"> |
| |
| <h1 class="page-header">UserService <small>Resource</small></h1> |
| |
| <p></p> |
| <ul> |
| <li><a href="#resource_UserService_createAdminUser_POST">./userService/createAdminUser</a></li> |
| <li><a href="#resource_UserService_createGuestUser_GET">./userService/createGuestUser</a></li> |
| <li><a href="#resource_UserService_createUser_POST">./userService/createUser</a></li> |
| <li><a href="#resource_UserService_deleteUser_GET">./userService/deleteUser/{userName}</a></li> |
| <li><a href="#resource_UserService_getCurrentUserOperations_GET">./userService/getCurrentUserOperations</a></li> |
| <li><a href="#resource_UserService_getCurrentUserPermissions_GET">./userService/getCurrentUserPermissions</a></li> |
| <li><a href="#resource_UserService_getGuestUser_GET">./userService/getGuestUser</a></li> |
| <li><a href="#resource_UserService_getUser_GET">./userService/getUser/{userName}</a></li> |
| <li><a href="#resource_UserService_getUserOperations_GET">./userService/getUserOperations/{userName}</a></li> |
| <li><a href="#resource_UserService_getUserPermissions_GET">./userService/getUserPermissions/{userName}</a></li> |
| <li><a href="#resource_UserService_getUsers_GET">./userService/getUsers</a></li> |
| <li><a href="#resource_UserService_isAdminUserExists_GET">./userService/isAdminUserExists</a></li> |
| <li><a href="#resource_UserService_lockUser_GET">./userService/lockUser/{username}</a></li> |
| <li><a href="#resource_UserService_passwordChangeNotRequired_GET">./userService/passwordChangeNotRequired/{username}</a></li> |
| <li><a href="#resource_UserService_passwordChangeRequired_GET">./userService/passwordChangeRequired/{username}</a></li> |
| <li><a href="#resource_UserService_ping_GET">./userService/ping</a></li> |
| <li><a href="#resource_UserService_registerUser_POST">./userService/registerUser</a></li> |
| <li><a href="#resource_UserService_removeFromCache_GET">./userService/removeFromCache/{userName}</a></li> |
| <li><a href="#resource_UserService_resetPassword_POST">./userService/resetPassword</a></li> |
| <li><a href="#resource_UserService_unlockUser_GET">./userService/unlockUser/{username}</a></li> |
| <li><a href="#resource_UserService_updateMe_POST">./userService/updateMe</a></li> |
| <li><a href="#resource_UserService_updateUser_POST">./userService/updateUser</a></li> |
| <li><a href="#resource_UserService_validateUserFromKey_GET">./userService/validateKey/{key}</a></li> |
| </ul> |
| |
| <div id="resource_UserService_createAdminUser_POST"> |
| <h2>POST <small>/userService/createAdminUser <a href="./userService/createAdminUser" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p>will create admin user only if not exists !! if exists will return false</p> |
| |
| <table class="table"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server.">application/xml</abbr></td> |
| <td><a href="xml_ns0_user.html">user</a> |
| (XML)</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <div id="resource_UserService_createGuestUser_GET"> |
| <h2>GET <small>/userService/createGuestUser <a href="./userService/createGuestUser" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td><a href="xml_ns0_user.html">user</a> |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <div id="resource_UserService_createUser_POST"> |
| <h2>POST <small>/userService/createUser <a href="./userService/createUser" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <table class="table"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server.">application/xml</abbr></td> |
| <td><a href="xml_ns0_user.html">user</a> |
| (XML)</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <div id="resource_UserService_deleteUser_GET"> |
| <h2>GET <small>/userService/deleteUser/{userName} <a href="./userService/deleteUser/{userName}" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>userName</td> |
| <td>path</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>1.4</dd> |
| </dl> |
| |
| <div id="resource_UserService_getCurrentUserOperations_GET"> |
| <h2>GET <small>/userService/getCurrentUserOperations <a href="./userService/getCurrentUserOperations" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>1.4</dd> |
| </dl> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>list of <a href="xml_ns0_operation.html">operation</a> |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>1.4</dd> |
| </dl> |
| |
| <div id="resource_UserService_getCurrentUserPermissions_GET"> |
| <h2>GET <small>/userService/getCurrentUserPermissions <a href="./userService/getCurrentUserPermissions" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>1.4</dd> |
| </dl> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>list of <a href="xml_ns0_permission.html">permission</a> |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <div id="resource_UserService_getGuestUser_GET"> |
| <h2>GET <small>/userService/getGuestUser <a href="./userService/getGuestUser" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td><a href="xml_ns0_user.html">user</a> |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <div id="resource_UserService_getUser_GET"> |
| <h2>GET <small>/userService/getUser/{userName} <a href="./userService/getUser/{userName}" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>userName</td> |
| <td>path</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td><a href="xml_ns0_user.html">user</a> |
| (XML)</td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>1.4</dd> |
| </dl> |
| |
| <div id="resource_UserService_getUserOperations_GET"> |
| <h2>GET <small>/userService/getUserOperations/{userName} <a href="./userService/getUserOperations/{userName}" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>1.4</dd> |
| </dl> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>userName</td> |
| <td>path</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>list of <a href="xml_ns0_operation.html">operation</a> |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>1.4</dd> |
| </dl> |
| |
| <div id="resource_UserService_getUserPermissions_GET"> |
| <h2>GET <small>/userService/getUserPermissions/{userName} <a href="./userService/getUserPermissions/{userName}" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>1.4</dd> |
| </dl> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>userName</td> |
| <td>path</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>list of <a href="xml_ns0_permission.html">permission</a> |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <div id="resource_UserService_getUsers_GET"> |
| <h2>GET <small>/userService/getUsers <a href="./userService/getUsers" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>list of <a href="xml_ns0_user.html">user</a> |
| (XML)</td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <div id="resource_UserService_isAdminUserExists_GET"> |
| <h2>GET <small>/userService/isAdminUserExists <a href="./userService/isAdminUserExists" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <div id="resource_UserService_lockUser_GET"> |
| <h2>GET <small>/userService/lockUser/{username} <a href="./userService/lockUser/{username}" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>username</td> |
| <td>path</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <div id="resource_UserService_passwordChangeNotRequired_GET"> |
| <h2>GET <small>/userService/passwordChangeNotRequired/{username} <a href="./userService/passwordChangeNotRequired/{username}" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>username</td> |
| <td>path</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <div id="resource_UserService_passwordChangeRequired_GET"> |
| <h2>GET <small>/userService/passwordChangeRequired/{username} <a href="./userService/passwordChangeRequired/{username}" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>username</td> |
| <td>path</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <div id="resource_UserService_ping_GET"> |
| <h2>GET <small>/userService/ping <a href="./userService/ping" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>1.4</dd> |
| </dl> |
| |
| <div id="resource_UserService_registerUser_POST"> |
| <h2>POST <small>/userService/registerUser <a href="./userService/registerUser" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p>if redback is not configured for email validation is required, -1 is returned as key</p> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>1.4</dd> |
| </dl> |
| |
| <table class="table"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server.">application/xml</abbr></td> |
| <td><a href="xml_ns0_userRegistrationRequest.html">userRegistrationRequest</a> |
| (XML)</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td><a href="xml_ns0_registrationKey.html">registrationKey</a> |
| (XML)</td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <div id="resource_UserService_removeFromCache_GET"> |
| <h2>GET <small>/userService/removeFromCache/{userName} <a href="./userService/removeFromCache/{userName}" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>userName</td> |
| <td>path</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>int |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>1.4</dd> |
| </dl> |
| |
| <div id="resource_UserService_resetPassword_POST"> |
| <h2>POST <small>/userService/resetPassword <a href="./userService/resetPassword" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>1.4</dd> |
| </dl> |
| |
| <table class="table"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| <td rowspan="2">contains username for send a password reset email</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server.">application/xml</abbr></td> |
| <td><a href="xml_ns0_resetPasswordRequest.html">resetPasswordRequest</a> |
| (XML)</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <div id="resource_UserService_unlockUser_GET"> |
| <h2>GET <small>/userService/unlockUser/{username} <a href="./userService/unlockUser/{username}" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>username</td> |
| <td>path</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>1.4</dd> |
| </dl> |
| |
| <div id="resource_UserService_updateMe_POST"> |
| <h2>POST <small>/userService/updateMe <a href="./userService/updateMe" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p>update only the current user and this fields: fullname, email, password. |
| the service verify the curent logged user with the one passed in the method</p> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>1.4</dd> |
| </dl> |
| |
| <table class="table"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server.">application/xml</abbr></td> |
| <td><a href="xml_ns0_user.html">user</a> |
| (XML)</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <div id="resource_UserService_updateUser_POST"> |
| <h2>POST <small>/userService/updateUser <a href="./userService/updateUser" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <table class="table"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server.">application/xml</abbr></td> |
| <td><a href="xml_ns0_user.html">user</a> |
| (XML)</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>1.4</dd> |
| </dl> |
| |
| <div id="resource_UserService_validateUserFromKey_GET"> |
| <h2>GET <small>/userService/validateKey/{key} <a href="./userService/validateKey/{key}" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p>validate the key and the user with forcing a password change for next login. |
| http session is created.</p> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>1.4</dd> |
| </dl> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>key</td> |
| <td>path</td> |
| <td>authentication key</td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>(custom) |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <footer> |
| <div class="footer"> |
| Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>. |
| </div> |
| </footer> |
| |
| </div> |
| |
| </div> |
| |
| |
| <!-- JavaScript placed at the end of the document so the pages load faster. --> |
| <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script> |
| |
| |
| <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/run_prettify.js" type="text/javascript"></script> |
| |
| |
| </body> |
| </html> |
