Google Git
Sign in
apache / ranger-site / a2400e1b7e0fd42bd870c26f2842c001ce98deea / . / apidocs / resource_UserREST.html
blob: 57b287e5381ee82f09cf6aa38c76db01b33f2c62 [file] [log] [blame]
<!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>Ranger REST API: UserREST</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/enunciate.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 data-spy="scroll" data-target="#apinav">
<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">Ranger REST API: UserREST</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>
</ul>
</div>
</div>
</nav>
<div class="container-fluid">
<div class="row">
<div class="col-sm-3 col-md-2 sidebar" id="apinav">
<ul class="nav nav-sidebar">
<li><a href="#resource_UserREST_searchUsers_GET"><abbr title="GET /users"><span class="sideoverflow">GET /users</span></abbr></a></li>
<li><a href="#resource_UserREST_create_POST"><abbr title="POST /users"><span class="sideoverflow">POST /users</span></abbr></a></li>
<li><a href="#resource_UserREST_update_PUT"><abbr title="PUT /users"><span class="sideoverflow">PUT /users</span></abbr></a></li>
<li><a href="#resource_UserREST_createDefaultAccountUser_POST"><abbr title="POST /users/default"><span class="sideoverflow">POST /users/default</span></abbr></a></li>
<li><a href="#resource_UserREST_suggestUserFirstName_GET"><abbr title="GET /users/firstnames"><span class="sideoverflow">GET /users/firstnames</span></abbr></a></li>
<li><a href="#resource_UserREST_getUserProfile_GET"><abbr title="GET /users/profile"><span class="sideoverflow">GET /users/profile</span></abbr></a></li>
<li><a href="#resource_UserREST_getUserProfileForUser_GET"><abbr title="GET /users/{userId}"><span class="sideoverflow">GET /users/{userId}</span></abbr></a></li>
<li><a href="#resource_UserREST_deactivateUser_POST"><abbr title="POST /users/{userId}/deactivate"><span class="sideoverflow">POST /users/{userId}/deactivate</span></abbr></a></li>
<li><a href="#resource_UserREST_changeEmailAddress_POST"><abbr title="POST /users/{userId}/emailchange"><span class="sideoverflow">POST /users/{userId}/emailchange</span></abbr></a></li>
<li><a href="#resource_UserREST_changePassword_POST"><abbr title="POST /users/{userId}/passwordchange"><span class="sideoverflow">POST /users/{userId}/passwordchange</span></abbr></a></li>
<li><a href="#resource_UserREST_setUserRoles_PUT"><abbr title="PUT /users/{userId}/roles"><span class="sideoverflow">PUT /users/{userId}/roles</span></abbr></a></li>
<li class="divider"></li>
<li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
</ul>
</div>
<div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
<ol class="breadcrumb" id="top">
<li class="active dropdown"><a href="index.html">Home</a></li>
<li class="active dropdown"><a href="resources.html">Resources</a></li>
<li class="dropdown"><a href="resource_UserREST.html">UserREST</a></li>
</ol>
<h1 class="page-header">UserREST <small>Resource</small></h1>
<p></p>
<div id="resource_UserREST_searchUsers_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/users <a href="../users" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p>Implements the traditional search functionalities for UserProfile</p>
<table class="table resource-response-body">
<caption>Response 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 &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_VXPortalUserList.html">VXPortalUserList</a>
(JSON)</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
<td><span class="datatype-reference"><a href="xml_ns0_VXPortalUserList.html">VXPortalUserList</a>
(XML)</span></td>
</tr>
</tbody>
</table>
<h4>Example</h4>
<div class="container-fluid example panel">
<div class="row panel-body">
<div class="col-md-6">
<h5>Request</h5>
<pre>
GET /users
Content-Type: */*
Accept: application/json
<code class="prettyprint language-txt">
...
</code>
</pre>
</div>
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
Content-Type: application/json
<code class="prettyprint language-js">
{
&quot;vXPortalUsers&quot; : [ {
&quot;loginId&quot; : &quot;...&quot;,
&quot;password&quot; : &quot;...&quot;,
&quot;status&quot; : 12345,
&quot;emailAddress&quot; : &quot;...&quot;,
&quot;firstName&quot; : &quot;...&quot;,
&quot;lastName&quot; : &quot;...&quot;,
&quot;publicScreenName&quot; : &quot;...&quot;,
&quot;userSource&quot; : 12345,
&quot;notes&quot; : &quot;...&quot;,
&quot;userRoleList&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;myClassType&quot; : 12345,
&quot;groupIdList&quot; : [ 12345, 12345 ],
&quot;userPermList&quot; : [ {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;groupPermissions&quot; : [ {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;otherAttributes&quot; : &quot;...&quot;,
&quot;configProperties&quot; : {
&quot;property1&quot; : &quot;...&quot;,
&quot;property2&quot; : &quot;...&quot;
},
&quot;syncSource&quot; : &quot;...&quot;,
&quot;id&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;loginId&quot; : &quot;...&quot;,
&quot;password&quot; : &quot;...&quot;,
&quot;status&quot; : 12345,
&quot;emailAddress&quot; : &quot;...&quot;,
&quot;firstName&quot; : &quot;...&quot;,
&quot;lastName&quot; : &quot;...&quot;,
&quot;publicScreenName&quot; : &quot;...&quot;,
&quot;userSource&quot; : 12345,
&quot;notes&quot; : &quot;...&quot;,
&quot;userRoleList&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;myClassType&quot; : 12345,
&quot;groupIdList&quot; : [ 12345, 12345 ],
&quot;userPermList&quot; : [ {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;groupPermissions&quot; : [ {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;otherAttributes&quot; : &quot;...&quot;,
&quot;configProperties&quot; : {
&quot;property1&quot; : &quot;...&quot;,
&quot;property2&quot; : &quot;...&quot;
},
&quot;syncSource&quot; : &quot;...&quot;,
&quot;id&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;listSize&quot; : 12345,
&quot;list&quot; : [ { }, { } ],
&quot;startIndex&quot; : 12345,
&quot;pageSize&quot; : 12345,
&quot;totalCount&quot; : 12345,
&quot;resultSize&quot; : 12345,
&quot;sortType&quot; : &quot;...&quot;,
&quot;sortBy&quot; : &quot;...&quot;
}
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_UserREST_create_POST">
<h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/users <a href="../users" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<table class="table resource-request-body">
<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 &quot;Content-Type: application/json&quot; HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_VXPortalUser.html">VXPortalUser</a>
(JSON)</span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Content-Type: application/xml&quot; HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td>
<td><span class="datatype-reference"><a href="xml_ns0_VXPortalUser.html">VXPortalUser</a>
(XML)</span></td>
</tr>
</tbody>
</table>
<table class="table resource-response-body">
<caption>Response 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 &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_VXPortalUser.html">VXPortalUser</a>
(JSON)</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
<td><span class="datatype-reference"><a href="xml_ns0_VXPortalUser.html">VXPortalUser</a>
(XML)</span></td>
</tr>
</tbody>
</table>
<h4>Example</h4>
<div class="container-fluid example panel">
<div class="row panel-body">
<div class="col-md-6">
<h5>Request</h5>
<pre>
POST /users
Content-Type: application/json
Accept: application/json
<code class="prettyprint language-js">
{
&quot;loginId&quot; : &quot;...&quot;,
&quot;password&quot; : &quot;...&quot;,
&quot;status&quot; : 12345,
&quot;emailAddress&quot; : &quot;...&quot;,
&quot;firstName&quot; : &quot;...&quot;,
&quot;lastName&quot; : &quot;...&quot;,
&quot;publicScreenName&quot; : &quot;...&quot;,
&quot;userSource&quot; : 12345,
&quot;notes&quot; : &quot;...&quot;,
&quot;userRoleList&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;myClassType&quot; : 12345,
&quot;groupIdList&quot; : [ 12345, 12345 ],
&quot;userPermList&quot; : [ {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;groupPermissions&quot; : [ {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;otherAttributes&quot; : &quot;...&quot;,
&quot;configProperties&quot; : {
&quot;property1&quot; : &quot;...&quot;,
&quot;property2&quot; : &quot;...&quot;
},
&quot;syncSource&quot; : &quot;...&quot;,
&quot;id&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}
</code>
</pre>
</div>
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 201 Created
Content-Type: application/json
<code class="prettyprint language-js">
{
&quot;loginId&quot; : &quot;...&quot;,
&quot;password&quot; : &quot;...&quot;,
&quot;status&quot; : 12345,
&quot;emailAddress&quot; : &quot;...&quot;,
&quot;firstName&quot; : &quot;...&quot;,
&quot;lastName&quot; : &quot;...&quot;,
&quot;publicScreenName&quot; : &quot;...&quot;,
&quot;userSource&quot; : 12345,
&quot;notes&quot; : &quot;...&quot;,
&quot;userRoleList&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;myClassType&quot; : 12345,
&quot;groupIdList&quot; : [ 12345, 12345 ],
&quot;userPermList&quot; : [ {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;groupPermissions&quot; : [ {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;otherAttributes&quot; : &quot;...&quot;,
&quot;configProperties&quot; : {
&quot;property1&quot; : &quot;...&quot;,
&quot;property2&quot; : &quot;...&quot;
},
&quot;syncSource&quot; : &quot;...&quot;,
&quot;id&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_UserREST_update_PUT">
<h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/users <a href="../users" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<table class="table resource-request-body">
<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 &quot;Content-Type: application/json&quot; HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_VXPortalUser.html">VXPortalUser</a>
(JSON)</span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Content-Type: application/xml&quot; HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td>
<td><span class="datatype-reference"><a href="xml_ns0_VXPortalUser.html">VXPortalUser</a>
(XML)</span></td>
</tr>
</tbody>
</table>
<table class="table resource-response-body">
<caption>Response 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 &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_VXPortalUser.html">VXPortalUser</a>
(JSON)</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
<td><span class="datatype-reference"><a href="xml_ns0_VXPortalUser.html">VXPortalUser</a>
(XML)</span></td>
</tr>
</tbody>
</table>
<h4>Example</h4>
<div class="container-fluid example panel">
<div class="row panel-body">
<div class="col-md-6">
<h5>Request</h5>
<pre>
PUT /users
Content-Type: application/json
Accept: application/json
<code class="prettyprint language-js">
{
&quot;loginId&quot; : &quot;...&quot;,
&quot;password&quot; : &quot;...&quot;,
&quot;status&quot; : 12345,
&quot;emailAddress&quot; : &quot;...&quot;,
&quot;firstName&quot; : &quot;...&quot;,
&quot;lastName&quot; : &quot;...&quot;,
&quot;publicScreenName&quot; : &quot;...&quot;,
&quot;userSource&quot; : 12345,
&quot;notes&quot; : &quot;...&quot;,
&quot;userRoleList&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;myClassType&quot; : 12345,
&quot;groupIdList&quot; : [ 12345, 12345 ],
&quot;userPermList&quot; : [ {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;groupPermissions&quot; : [ {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;otherAttributes&quot; : &quot;...&quot;,
&quot;configProperties&quot; : {
&quot;property1&quot; : &quot;...&quot;,
&quot;property2&quot; : &quot;...&quot;
},
&quot;syncSource&quot; : &quot;...&quot;,
&quot;id&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}
</code>
</pre>
</div>
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 204 No Content
Content-Type: application/json
<code class="prettyprint language-js">
{
&quot;loginId&quot; : &quot;...&quot;,
&quot;password&quot; : &quot;...&quot;,
&quot;status&quot; : 12345,
&quot;emailAddress&quot; : &quot;...&quot;,
&quot;firstName&quot; : &quot;...&quot;,
&quot;lastName&quot; : &quot;...&quot;,
&quot;publicScreenName&quot; : &quot;...&quot;,
&quot;userSource&quot; : 12345,
&quot;notes&quot; : &quot;...&quot;,
&quot;userRoleList&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;myClassType&quot; : 12345,
&quot;groupIdList&quot; : [ 12345, 12345 ],
&quot;userPermList&quot; : [ {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;groupPermissions&quot; : [ {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;otherAttributes&quot; : &quot;...&quot;,
&quot;configProperties&quot; : {
&quot;property1&quot; : &quot;...&quot;,
&quot;property2&quot; : &quot;...&quot;
},
&quot;syncSource&quot; : &quot;...&quot;,
&quot;id&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_UserREST_createDefaultAccountUser_POST">
<h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/users/default <a href="../users/default" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<table class="table resource-request-body">
<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 &quot;Content-Type: application/json&quot; HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_VXPortalUser.html">VXPortalUser</a>
(JSON)</span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Content-Type: application/xml&quot; HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td>
<td><span class="datatype-reference"><a href="xml_ns0_VXPortalUser.html">VXPortalUser</a>
(XML)</span></td>
</tr>
</tbody>
</table>
<table class="table resource-response-body">
<caption>Response 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 &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_VXPortalUser.html">VXPortalUser</a>
(JSON)</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
<td><span class="datatype-reference"><a href="xml_ns0_VXPortalUser.html">VXPortalUser</a>
(XML)</span></td>
</tr>
</tbody>
</table>
<h4>Example</h4>
<div class="container-fluid example panel">
<div class="row panel-body">
<div class="col-md-6">
<h5>Request</h5>
<pre>
POST /users/default
Content-Type: application/json
Accept: application/json
<code class="prettyprint language-js">
{
&quot;loginId&quot; : &quot;...&quot;,
&quot;password&quot; : &quot;...&quot;,
&quot;status&quot; : 12345,
&quot;emailAddress&quot; : &quot;...&quot;,
&quot;firstName&quot; : &quot;...&quot;,
&quot;lastName&quot; : &quot;...&quot;,
&quot;publicScreenName&quot; : &quot;...&quot;,
&quot;userSource&quot; : 12345,
&quot;notes&quot; : &quot;...&quot;,
&quot;userRoleList&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;myClassType&quot; : 12345,
&quot;groupIdList&quot; : [ 12345, 12345 ],
&quot;userPermList&quot; : [ {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;groupPermissions&quot; : [ {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;otherAttributes&quot; : &quot;...&quot;,
&quot;configProperties&quot; : {
&quot;property1&quot; : &quot;...&quot;,
&quot;property2&quot; : &quot;...&quot;
},
&quot;syncSource&quot; : &quot;...&quot;,
&quot;id&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}
</code>
</pre>
</div>
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 201 Created
Content-Type: application/json
<code class="prettyprint language-js">
{
&quot;loginId&quot; : &quot;...&quot;,
&quot;password&quot; : &quot;...&quot;,
&quot;status&quot; : 12345,
&quot;emailAddress&quot; : &quot;...&quot;,
&quot;firstName&quot; : &quot;...&quot;,
&quot;lastName&quot; : &quot;...&quot;,
&quot;publicScreenName&quot; : &quot;...&quot;,
&quot;userSource&quot; : 12345,
&quot;notes&quot; : &quot;...&quot;,
&quot;userRoleList&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;myClassType&quot; : 12345,
&quot;groupIdList&quot; : [ 12345, 12345 ],
&quot;userPermList&quot; : [ {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;groupPermissions&quot; : [ {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;otherAttributes&quot; : &quot;...&quot;,
&quot;configProperties&quot; : {
&quot;property1&quot; : &quot;...&quot;,
&quot;property2&quot; : &quot;...&quot;
},
&quot;syncSource&quot; : &quot;...&quot;,
&quot;id&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_UserREST_suggestUserFirstName_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/users/firstnames <a href="../users/firstnames" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<table class="table resource-parameters">
<caption>Request Parameters</caption>
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parameter-name">letters</span></td>
<td>query</td>
<td><span class="parameter-description"></span></td>
</tr>
</tbody>
</table>
<table class="table resource-response-body">
<caption>Response 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 &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference">string
(JSON)</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
<td><span class="datatype-reference">string
(XML)</span></td>
</tr>
</tbody>
</table>
<h4>Example</h4>
<div class="container-fluid example panel">
<div class="row panel-body">
<div class="col-md-6">
<h5>Request</h5>
<pre>
GET /users/firstnames
Content-Type: */*
Accept: application/json
<code class="prettyprint language-txt">
...
</code>
</pre>
</div>
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
Content-Type: application/json
<code class="prettyprint language-txt">
...
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_UserREST_getUserProfile_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/users/profile <a href="../users/profile" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p>This method returns the VUserProfile for the current session</p>
<table class="table resource-response-body">
<caption>Response 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 &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_VXPortalUser.html">VXPortalUser</a>
(JSON)</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
<td><span class="datatype-reference"><a href="xml_ns0_VXPortalUser.html">VXPortalUser</a>
(XML)</span></td>
</tr>
</tbody>
</table>
<h4>Example</h4>
<div class="container-fluid example panel">
<div class="row panel-body">
<div class="col-md-6">
<h5>Request</h5>
<pre>
GET /users/profile
Content-Type: */*
Accept: application/json
<code class="prettyprint language-txt">
...
</code>
</pre>
</div>
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
Content-Type: application/json
<code class="prettyprint language-js">
{
&quot;loginId&quot; : &quot;...&quot;,
&quot;password&quot; : &quot;...&quot;,
&quot;status&quot; : 12345,
&quot;emailAddress&quot; : &quot;...&quot;,
&quot;firstName&quot; : &quot;...&quot;,
&quot;lastName&quot; : &quot;...&quot;,
&quot;publicScreenName&quot; : &quot;...&quot;,
&quot;userSource&quot; : 12345,
&quot;notes&quot; : &quot;...&quot;,
&quot;userRoleList&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;myClassType&quot; : 12345,
&quot;groupIdList&quot; : [ 12345, 12345 ],
&quot;userPermList&quot; : [ {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;groupPermissions&quot; : [ {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;otherAttributes&quot; : &quot;...&quot;,
&quot;configProperties&quot; : {
&quot;property1&quot; : &quot;...&quot;,
&quot;property2&quot; : &quot;...&quot;
},
&quot;syncSource&quot; : &quot;...&quot;,
&quot;id&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_UserREST_getUserProfileForUser_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/users/{userId} <a href="../users/{userId}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p>Return the VUserProfile for the given userId</p>
<table class="table resource-parameters">
<caption>Request Parameters</caption>
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
<th>constraints</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parameter-name">userId</span></td>
<td>path</td>
<td><span class="parameter-description"></span></td>
<td><span class="parameter-constraints">long</span></td>
</tr>
</tbody>
</table>
<table class="table resource-response-body">
<caption>Response 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 &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_VXPortalUser.html">VXPortalUser</a>
(JSON)</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
<td><span class="datatype-reference"><a href="xml_ns0_VXPortalUser.html">VXPortalUser</a>
(XML)</span></td>
</tr>
</tbody>
</table>
<h4>Example</h4>
<div class="container-fluid example panel">
<div class="row panel-body">
<div class="col-md-6">
<h5>Request</h5>
<pre>
GET /users/{userId}
Content-Type: */*
Accept: application/json
<code class="prettyprint language-txt">
...
</code>
</pre>
</div>
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
Content-Type: application/json
<code class="prettyprint language-js">
{
&quot;loginId&quot; : &quot;...&quot;,
&quot;password&quot; : &quot;...&quot;,
&quot;status&quot; : 12345,
&quot;emailAddress&quot; : &quot;...&quot;,
&quot;firstName&quot; : &quot;...&quot;,
&quot;lastName&quot; : &quot;...&quot;,
&quot;publicScreenName&quot; : &quot;...&quot;,
&quot;userSource&quot; : 12345,
&quot;notes&quot; : &quot;...&quot;,
&quot;userRoleList&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;myClassType&quot; : 12345,
&quot;groupIdList&quot; : [ 12345, 12345 ],
&quot;userPermList&quot; : [ {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;groupPermissions&quot; : [ {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;otherAttributes&quot; : &quot;...&quot;,
&quot;configProperties&quot; : {
&quot;property1&quot; : &quot;...&quot;,
&quot;property2&quot; : &quot;...&quot;
},
&quot;syncSource&quot; : &quot;...&quot;,
&quot;id&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_UserREST_deactivateUser_POST">
<h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/users/{userId}/deactivate <a href="../users/{userId}/deactivate" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p>Deactivate the user</p>
<table class="table resource-parameters">
<caption>Request Parameters</caption>
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
<th>constraints</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parameter-name">userId</span></td>
<td>path</td>
<td><span class="parameter-description"></span></td>
<td><span class="parameter-constraints">long</span></td>
</tr>
</tbody>
</table>
<table class="table resource-response-body">
<caption>Response 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 &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_VXPortalUser.html">VXPortalUser</a>
(JSON)</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
<td><span class="datatype-reference"><a href="xml_ns0_VXPortalUser.html">VXPortalUser</a>
(XML)</span></td>
</tr>
</tbody>
</table>
<h4>Example</h4>
<div class="container-fluid example panel">
<div class="row panel-body">
<div class="col-md-6">
<h5>Request</h5>
<pre>
POST /users/{userId}/deactivate
Content-Type: */*
Accept: application/json
<code class="prettyprint language-txt">
...
</code>
</pre>
</div>
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 201 Created
Content-Type: application/json
<code class="prettyprint language-js">
{
&quot;loginId&quot; : &quot;...&quot;,
&quot;password&quot; : &quot;...&quot;,
&quot;status&quot; : 12345,
&quot;emailAddress&quot; : &quot;...&quot;,
&quot;firstName&quot; : &quot;...&quot;,
&quot;lastName&quot; : &quot;...&quot;,
&quot;publicScreenName&quot; : &quot;...&quot;,
&quot;userSource&quot; : 12345,
&quot;notes&quot; : &quot;...&quot;,
&quot;userRoleList&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;myClassType&quot; : 12345,
&quot;groupIdList&quot; : [ 12345, 12345 ],
&quot;userPermList&quot; : [ {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;groupPermissions&quot; : [ {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;otherAttributes&quot; : &quot;...&quot;,
&quot;configProperties&quot; : {
&quot;property1&quot; : &quot;...&quot;,
&quot;property2&quot; : &quot;...&quot;
},
&quot;syncSource&quot; : &quot;...&quot;,
&quot;id&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_UserREST_changeEmailAddress_POST">
<h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/users/{userId}/emailchange <a href="../users/{userId}/emailchange" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<table class="table resource-parameters">
<caption>Request Parameters</caption>
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
<th>constraints</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parameter-name">userId</span></td>
<td>path</td>
<td><span class="parameter-description"></span></td>
<td><span class="parameter-constraints">long</span></td>
</tr>
</tbody>
</table>
<table class="table resource-request-body">
<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 &quot;Content-Type: application/json&quot; HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_VXPasswordChange.html">VXPasswordChange</a>
(JSON)</span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Content-Type: application/xml&quot; HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td>
<td><span class="datatype-reference"><a href="xml_ns0_VXPasswordChange.html">VXPasswordChange</a>
(XML)</span></td>
</tr>
</tbody>
</table>
<table class="table resource-response-body">
<caption>Response 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 &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_VXPortalUser.html">VXPortalUser</a>
(JSON)</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
<td><span class="datatype-reference"><a href="xml_ns0_VXPortalUser.html">VXPortalUser</a>
(XML)</span></td>
</tr>
</tbody>
</table>
<h4>Example</h4>
<div class="container-fluid example panel">
<div class="row panel-body">
<div class="col-md-6">
<h5>Request</h5>
<pre>
POST /users/{userId}/emailchange
Content-Type: application/json
Accept: application/json
<code class="prettyprint language-js">
{
&quot;id&quot; : 12345,
&quot;loginId&quot; : &quot;...&quot;,
&quot;emailAddress&quot; : &quot;...&quot;,
&quot;resetCode&quot; : &quot;...&quot;,
&quot;oldPassword&quot; : &quot;...&quot;,
&quot;updPassword&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345
}
</code>
</pre>
</div>
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 201 Created
Content-Type: application/json
<code class="prettyprint language-js">
{
&quot;loginId&quot; : &quot;...&quot;,
&quot;password&quot; : &quot;...&quot;,
&quot;status&quot; : 12345,
&quot;emailAddress&quot; : &quot;...&quot;,
&quot;firstName&quot; : &quot;...&quot;,
&quot;lastName&quot; : &quot;...&quot;,
&quot;publicScreenName&quot; : &quot;...&quot;,
&quot;userSource&quot; : 12345,
&quot;notes&quot; : &quot;...&quot;,
&quot;userRoleList&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;myClassType&quot; : 12345,
&quot;groupIdList&quot; : [ 12345, 12345 ],
&quot;userPermList&quot; : [ {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;userId&quot; : 12345,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;userName&quot; : &quot;...&quot;,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;loginId&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;groupPermissions&quot; : [ {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}, {
&quot;id&quot; : 12345,
&quot;groupId&quot; : 12345,
&quot;groupName&quot; : &quot;...&quot;,
&quot;moduleId&quot; : 12345,
&quot;isAllowed&quot; : 12345,
&quot;moduleName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
} ],
&quot;otherAttributes&quot; : &quot;...&quot;,
&quot;configProperties&quot; : {
&quot;property1&quot; : &quot;...&quot;,
&quot;property2&quot; : &quot;...&quot;
},
&quot;syncSource&quot; : &quot;...&quot;,
&quot;id&quot; : 12345,
&quot;createDate&quot; : 12345,
&quot;updateDate&quot; : 12345,
&quot;owner&quot; : &quot;...&quot;,
&quot;updatedBy&quot; : &quot;...&quot;
}
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_UserREST_changePassword_POST">
<h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/users/{userId}/passwordchange <a href="../users/{userId}/passwordchange" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<table class="table resource-parameters">
<caption>Request Parameters</caption>
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
<th>constraints</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parameter-name">userId</span></td>
<td>path</td>
<td><span class="parameter-description"></span></td>
<td><span class="parameter-constraints">long</span></td>
</tr>
</tbody>
</table>
<table class="table resource-request-body">
<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 &quot;Content-Type: application/json&quot; HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_VXPasswordChange.html">VXPasswordChange</a>
(JSON)</span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Content-Type: application/xml&quot; HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td>
<td><span class="datatype-reference"><a href="xml_ns0_VXPasswordChange.html">VXPasswordChange</a>
(XML)</span></td>
</tr>
</tbody>
</table>
<table class="table resource-response-body">
<caption>Response 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 &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_VXResponse.html">VXResponse</a>
(JSON)</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
<td><span class="datatype-reference"><a href="xml_ns0_VXResponse.html">VXResponse</a>
(XML)</span></td>
</tr>
</tbody>
</table>
<h4>Example</h4>
<div class="container-fluid example panel">
<div class="row panel-body">
<div class="col-md-6">
<h5>Request</h5>
<pre>
POST /users/{userId}/passwordchange
Content-Type: application/json
Accept: application/json
<code class="prettyprint language-js">
{
&quot;id&quot; : 12345,
&quot;loginId&quot; : &quot;...&quot;,
&quot;emailAddress&quot; : &quot;...&quot;,
&quot;resetCode&quot; : &quot;...&quot;,
&quot;oldPassword&quot; : &quot;...&quot;,
&quot;updPassword&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345
}
</code>
</pre>
</div>
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 201 Created
Content-Type: application/json
<code class="prettyprint language-js">
{
&quot;statusCode&quot; : 12345,
&quot;msgDesc&quot; : &quot;...&quot;,
&quot;messageList&quot; : [ {
&quot;name&quot; : &quot;...&quot;,
&quot;rbKey&quot; : &quot;...&quot;,
&quot;message&quot; : &quot;...&quot;,
&quot;objectId&quot; : 12345,
&quot;fieldName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345
}, {
&quot;name&quot; : &quot;...&quot;,
&quot;rbKey&quot; : &quot;...&quot;,
&quot;message&quot; : &quot;...&quot;,
&quot;objectId&quot; : 12345,
&quot;fieldName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345
} ],
&quot;myClassType&quot; : 12345
}
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_UserREST_setUserRoles_PUT">
<h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/users/{userId}/roles <a href="../users/{userId}/roles" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<table class="table resource-parameters">
<caption>Request Parameters</caption>
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
<th>constraints</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parameter-name">userId</span></td>
<td>path</td>
<td><span class="parameter-description"></span></td>
<td><span class="parameter-constraints">long</span></td>
</tr>
</tbody>
</table>
<table class="table resource-request-body">
<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 &quot;Content-Type: application/json&quot; HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_VXStringList.html">VXStringList</a>
(JSON)</span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Content-Type: application/xml&quot; HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td>
<td><span class="datatype-reference"><a href="xml_ns0_VXStringList.html">VXStringList</a>
(XML)</span></td>
</tr>
</tbody>
</table>
<table class="table resource-response-body">
<caption>Response 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 &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_VXResponse.html">VXResponse</a>
(JSON)</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
<td><span class="datatype-reference"><a href="xml_ns0_VXResponse.html">VXResponse</a>
(XML)</span></td>
</tr>
</tbody>
</table>
<h4>Example</h4>
<div class="container-fluid example panel">
<div class="row panel-body">
<div class="col-md-6">
<h5>Request</h5>
<pre>
PUT /users/{userId}/roles
Content-Type: application/json
Accept: application/json
<code class="prettyprint language-js">
{
&quot;vXStrings&quot; : [ {
&quot;value&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345
}, {
&quot;value&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345
} ],
&quot;listSize&quot; : 12345,
&quot;list&quot; : [ { }, { } ],
&quot;startIndex&quot; : 12345,
&quot;pageSize&quot; : 12345,
&quot;totalCount&quot; : 12345,
&quot;resultSize&quot; : 12345,
&quot;sortType&quot; : &quot;...&quot;,
&quot;sortBy&quot; : &quot;...&quot;
}
</code>
</pre>
</div>
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 204 No Content
Content-Type: application/json
<code class="prettyprint language-js">
{
&quot;statusCode&quot; : 12345,
&quot;msgDesc&quot; : &quot;...&quot;,
&quot;messageList&quot; : [ {
&quot;name&quot; : &quot;...&quot;,
&quot;rbKey&quot; : &quot;...&quot;,
&quot;message&quot; : &quot;...&quot;,
&quot;objectId&quot; : 12345,
&quot;fieldName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345
}, {
&quot;name&quot; : &quot;...&quot;,
&quot;rbKey&quot; : &quot;...&quot;,
&quot;message&quot; : &quot;...&quot;,
&quot;objectId&quot; : 12345,
&quot;fieldName&quot; : &quot;...&quot;,
&quot;myClassType&quot; : 12345
} ],
&quot;myClassType&quot; : 12345
}
</code>
</pre>
</div>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
</div>
</footer>
</div>
</div>
</div>
<!-- JavaScript placed at the end of the document so the pages load faster. -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
<!-- Bootstrap core JavaScript
================================================== -->
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
<!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
<script>
$(function() {
$(".clickable-row").click(function() {
window.document.location = $(this).data("href");
});
$('[data-toggle="tooltip"]').tooltip()
});
</script>
</body>
</html>