apidocs/resource_XUserREST.html

<!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">  <title>Ranger REST API: XUserREST</title>  <meta name="viewport" content="width=device-width, initial-scale=1.0">  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">  <link rel="stylesheet" href="css/enunciate.css">   </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: XUserREST</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_XUserREST_searchXAuditMaps_GET"><abbr title="GET /xusers/auditmaps"><span class="sideoverflow">GET /xusers/auditmaps</span></abbr></a></li> <li><a href="#resource_XUserREST_createXAuditMap_POST"><abbr title="POST /xusers/auditmaps"><span class="sideoverflow">POST /xusers/auditmaps</span></abbr></a></li> <li><a href="#resource_XUserREST_updateXAuditMap_PUT"><abbr title="PUT /xusers/auditmaps"><span class="sideoverflow">PUT /xusers/auditmaps</span></abbr></a></li> <li><a href="#resource_XUserREST_getAuthSessions_GET"><abbr title="GET /xusers/authSessions"><span class="sideoverflow">GET /xusers/authSessions</span></abbr></a></li> <li><a href="#resource_XUserREST_searchXGroupGroups_GET"><abbr title="GET /xusers/groupgroups"><span class="sideoverflow">GET /xusers/groupgroups</span></abbr></a></li> <li><a href="#resource_XUserREST_createXGroupGroup_POST"><abbr title="POST /xusers/groupgroups"><span class="sideoverflow">POST /xusers/groupgroups</span></abbr></a></li> <li><a href="#resource_XUserREST_updateXGroupGroup_PUT"><abbr title="PUT /xusers/groupgroups"><span class="sideoverflow">PUT /xusers/groupgroups</span></abbr></a></li> <li><a href="#resource_XUserREST_searchXGroups_GET"><abbr title="GET /xusers/groups"><span class="sideoverflow">GET /xusers/groups</span></abbr></a></li> <li><a href="#resource_XUserREST_createXGroup_POST"><abbr title="POST /xusers/groups"><span class="sideoverflow">POST /xusers/groups</span></abbr></a></li> <li><a href="#resource_XUserREST_updateXGroup_PUT"><abbr title="PUT /xusers/groups"><span class="sideoverflow">PUT /xusers/groups</span></abbr></a></li> <li><a href="#resource_XUserREST_searchXGroupUsers_GET"><abbr title="GET /xusers/groupusers"><span class="sideoverflow">GET /xusers/groupusers</span></abbr></a></li> <li><a href="#resource_XUserREST_createXGroupUser_POST"><abbr title="POST /xusers/groupusers"><span class="sideoverflow">POST /xusers/groupusers</span></abbr></a></li> <li><a href="#resource_XUserREST_updateXGroupUser_PUT"><abbr title="PUT /xusers/groupusers"><span class="sideoverflow">PUT /xusers/groupusers</span></abbr></a></li> <li><a href="#resource_XUserREST_searchXModuleDef_GET"><abbr title="GET /xusers/permission"><span class="sideoverflow">GET /xusers/permission</span></abbr></a></li> <li><a href="#resource_XUserREST_createXModuleDefPermission_POST"><abbr title="POST /xusers/permission"><span class="sideoverflow">POST /xusers/permission</span></abbr></a></li> <li><a href="#resource_XUserREST_searchXPermMaps_GET"><abbr title="GET /xusers/permmaps"><span class="sideoverflow">GET /xusers/permmaps</span></abbr></a></li> <li><a href="#resource_XUserREST_createXPermMap_POST"><abbr title="POST /xusers/permmaps"><span class="sideoverflow">POST /xusers/permmaps</span></abbr></a></li> <li><a href="#resource_XUserREST_updateXPermMap_PUT"><abbr title="PUT /xusers/permmaps"><span class="sideoverflow">PUT /xusers/permmaps</span></abbr></a></li> <li><a href="#resource_XUserREST_searchXUsers_GET"><abbr title="GET /xusers/users"><span class="sideoverflow">GET /xusers/users</span></abbr></a></li> <li><a href="#resource_XUserREST_createXUser_POST"><abbr title="POST /xusers/users"><span class="sideoverflow">POST /xusers/users</span></abbr></a></li> <li><a href="#resource_XUserREST_updateXUser_PUT"><abbr title="PUT /xusers/users"><span class="sideoverflow">PUT /xusers/users</span></abbr></a></li> <li><a href="#resource_XUserREST_countXAuditMaps_GET"><abbr title="GET /xusers/auditmaps/count"><span class="sideoverflow">GET /xusers/auditmaps/count</span></abbr></a></li> <li><a href="#resource_XUserREST_deleteXAuditMap_DELETE"><abbr title="DELETE /xusers/auditmaps/{id}"><span class="sideoverflow">DELETE /xusers/auditmaps/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_getXAuditMap_GET"><abbr title="GET /xusers/auditmaps/{id}"><span class="sideoverflow">GET /xusers/auditmaps/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_getAuthSession_GET"><abbr title="GET /xusers/authSessions/info"><span class="sideoverflow">GET /xusers/authSessions/info</span></abbr></a></li> <li><a href="#resource_XUserREST_countXGroupGroups_GET"><abbr title="GET /xusers/groupgroups/count"><span class="sideoverflow">GET /xusers/groupgroups/count</span></abbr></a></li> <li><a href="#resource_XUserREST_deleteXGroupGroup_DELETE"><abbr title="DELETE /xusers/groupgroups/{id}"><span class="sideoverflow">DELETE /xusers/groupgroups/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_getXGroupGroup_GET"><abbr title="GET /xusers/groupgroups/{id}"><span class="sideoverflow">GET /xusers/groupgroups/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_countXGroups_GET"><abbr title="GET /xusers/groups/count"><span class="sideoverflow">GET /xusers/groups/count</span></abbr></a></li> <li><a href="#resource_XUserREST_createXGroupUserFromMap_POST"><abbr title="POST /xusers/groups/groupinfo"><span class="sideoverflow">POST /xusers/groups/groupinfo</span></abbr></a></li> <li><a href="#resource_XUserREST_deleteXGroup_DELETE"><abbr title="DELETE /xusers/groups/{id}"><span class="sideoverflow">DELETE /xusers/groups/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_getXGroup_GET"><abbr title="GET /xusers/groups/{id}"><span class="sideoverflow">GET /xusers/groups/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_countXGroupUsers_GET"><abbr title="GET /xusers/groupusers/count"><span class="sideoverflow">GET /xusers/groupusers/count</span></abbr></a></li> <li><a href="#resource_XUserREST_deleteXGroupUser_DELETE"><abbr title="DELETE /xusers/groupusers/{id}"><span class="sideoverflow">DELETE /xusers/groupusers/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_getXGroupUser_GET"><abbr title="GET /xusers/groupusers/{id}"><span class="sideoverflow">GET /xusers/groupusers/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_getGroupsLookup_GET"><abbr title="GET /xusers/lookup/groups"><span class="sideoverflow">GET /xusers/lookup/groups</span></abbr></a></li> <li><a href="#resource_XUserREST_getUsersLookup_GET"><abbr title="GET /xusers/lookup/users"><span class="sideoverflow">GET /xusers/lookup/users</span></abbr></a></li> <li><a href="#resource_XUserREST_countXModuleDef_GET"><abbr title="GET /xusers/permission/count"><span class="sideoverflow">GET /xusers/permission/count</span></abbr></a></li> <li><a href="#resource_XUserREST_searchXGroupPermission_GET"><abbr title="GET /xusers/permission/group"><span class="sideoverflow">GET /xusers/permission/group</span></abbr></a></li> <li><a href="#resource_XUserREST_createXGroupPermission_POST"><abbr title="POST /xusers/permission/group"><span class="sideoverflow">POST /xusers/permission/group</span></abbr></a></li> <li><a href="#resource_XUserREST_searchXUserPermission_GET"><abbr title="GET /xusers/permission/user"><span class="sideoverflow">GET /xusers/permission/user</span></abbr></a></li> <li><a href="#resource_XUserREST_createXUserPermission_POST"><abbr title="POST /xusers/permission/user"><span class="sideoverflow">POST /xusers/permission/user</span></abbr></a></li> <li><a href="#resource_XUserREST_deleteXModuleDefPermission_DELETE"><abbr title="DELETE /xusers/permission/{id}"><span class="sideoverflow">DELETE /xusers/permission/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_getXModuleDefPermission_GET"><abbr title="GET /xusers/permission/{id}"><span class="sideoverflow">GET /xusers/permission/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_updateXModuleDefPermission_PUT"><abbr title="PUT /xusers/permission/{id}"><span class="sideoverflow">PUT /xusers/permission/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_countXPermMaps_GET"><abbr title="GET /xusers/permmaps/count"><span class="sideoverflow">GET /xusers/permmaps/count</span></abbr></a></li> <li><a href="#resource_XUserREST_deleteXPermMap_DELETE"><abbr title="DELETE /xusers/permmaps/{id}"><span class="sideoverflow">DELETE /xusers/permmaps/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_getXPermMap_GET"><abbr title="GET /xusers/permmaps/{id}"><span class="sideoverflow">GET /xusers/permmaps/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_secureCreateXGroup_POST"><abbr title="POST /xusers/secure/groups"><span class="sideoverflow">POST /xusers/secure/groups</span></abbr></a></li> <li><a href="#resource_XUserREST_secureCreateXUser_POST"><abbr title="POST /xusers/secure/users"><span class="sideoverflow">POST /xusers/secure/users</span></abbr></a></li> <li><a href="#resource_XUserREST_postUserGroupAuditInfo_POST"><abbr title="POST /xusers/ugsync/auditinfo"><span class="sideoverflow">POST /xusers/ugsync/auditinfo</span></abbr></a></li> <li><a href="#resource_XUserREST_addOrUpdateGroups_POST"><abbr title="POST /xusers/ugsync/groups"><span class="sideoverflow">POST /xusers/ugsync/groups</span></abbr></a></li> <li><a href="#resource_XUserREST_getAllGroupUsers_GET"><abbr title="GET /xusers/ugsync/groupusers"><span class="sideoverflow">GET /xusers/ugsync/groupusers</span></abbr></a></li> <li><a href="#resource_XUserREST_addOrUpdateGroupUsersList_POST"><abbr title="POST /xusers/ugsync/groupusers"><span class="sideoverflow">POST /xusers/ugsync/groupusers</span></abbr></a></li> <li><a href="#resource_XUserREST_addOrUpdateUsers_POST"><abbr title="POST /xusers/ugsync/users"><span class="sideoverflow">POST /xusers/ugsync/users</span></abbr></a></li> <li><a href="#resource_XUserREST_countXUsers_GET"><abbr title="GET /xusers/users/count"><span class="sideoverflow">GET /xusers/users/count</span></abbr></a></li> <li><a href="#resource_XUserREST_createExternalUser_POST"><abbr title="POST /xusers/users/external"><span class="sideoverflow">POST /xusers/users/external</span></abbr></a></li> <li><a href="#resource_XUserREST_setXUserRolesByName_POST"><abbr title="POST /xusers/users/roleassignments"><span class="sideoverflow">POST /xusers/users/roleassignments</span></abbr></a></li> <li><a href="#resource_XUserREST_createXUserGroupFromMap_POST"><abbr title="POST /xusers/users/userinfo"><span class="sideoverflow">POST /xusers/users/userinfo</span></abbr></a></li> <li><a href="#resource_XUserREST_deleteXUser_DELETE"><abbr title="DELETE /xusers/users/{id}"><span class="sideoverflow">DELETE /xusers/users/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_getXUser_GET"><abbr title="GET /xusers/users/{id}"><span class="sideoverflow">GET /xusers/users/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_getXGroupUsers_GET"><abbr title="GET /xusers/{groupId}/users"><span class="sideoverflow">GET /xusers/{groupId}/users</span></abbr></a></li> <li><a href="#resource_XUserREST_getXUserGroups_GET"><abbr title="GET /xusers/{userId}/groups"><span class="sideoverflow">GET /xusers/{userId}/groups</span></abbr></a></li> <li><a href="#resource_XUserREST_deleteXGroupByGroupName_DELETE"><abbr title="DELETE /xusers/groups/groupName/{groupName}"><span class="sideoverflow">DELETE /xusers/groups/groupName/{groupName}</span></abbr></a></li> <li><a href="#resource_XUserREST_getXGroupByGroupName_GET"><abbr title="GET /xusers/groups/groupName/{groupName}"><span class="sideoverflow">GET /xusers/groups/groupName/{groupName}</span></abbr></a></li> <li><a href="#resource_XUserREST_getXGroupUsersByGroupName_GET"><abbr title="GET /xusers/groupusers/groupName/{groupName}"><span class="sideoverflow">GET /xusers/groupusers/groupName/{groupName}</span></abbr></a></li> <li><a href="#resource_XUserREST_countXGroupPermission_GET"><abbr title="GET /xusers/permission/group/count"><span class="sideoverflow">GET /xusers/permission/group/count</span></abbr></a></li> <li><a href="#resource_XUserREST_deleteXGroupPermission_DELETE"><abbr title="DELETE /xusers/permission/group/{id}"><span class="sideoverflow">DELETE /xusers/permission/group/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_getXGroupPermission_GET"><abbr title="GET /xusers/permission/group/{id}"><span class="sideoverflow">GET /xusers/permission/group/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_updateXGroupPermission_PUT"><abbr title="PUT /xusers/permission/group/{id}"><span class="sideoverflow">PUT /xusers/permission/group/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_countXUserPermission_GET"><abbr title="GET /xusers/permission/user/count"><span class="sideoverflow">GET /xusers/permission/user/count</span></abbr></a></li> <li><a href="#resource_XUserREST_deleteXUserPermission_DELETE"><abbr title="DELETE /xusers/permission/user/{id}"><span class="sideoverflow">DELETE /xusers/permission/user/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_getXUserPermission_GET"><abbr title="GET /xusers/permission/user/{id}"><span class="sideoverflow">GET /xusers/permission/user/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_updateXUserPermission_PUT"><abbr title="PUT /xusers/permission/user/{id}"><span class="sideoverflow">PUT /xusers/permission/user/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_getSecureRangerUserStoreIfUpdated_GET"><abbr title="GET /xusers/secure/download/{serviceName}"><span class="sideoverflow">GET /xusers/secure/download/{serviceName}</span></abbr></a></li> <li><a href="#resource_XUserREST_deleteGroupsByGroupName_DELETE"><abbr title="DELETE /xusers/secure/groups/delete"><span class="sideoverflow">DELETE /xusers/secure/groups/delete</span></abbr></a></li> <li><a href="#resource_XUserREST_modifyGroupsVisibility_PUT"><abbr title="PUT /xusers/secure/groups/visibility"><span class="sideoverflow">PUT /xusers/secure/groups/visibility</span></abbr></a></li> <li><a href="#resource_XUserREST_deleteSingleGroupByGroupName_DELETE"><abbr title="DELETE /xusers/secure/groups/{groupName}"><span class="sideoverflow">DELETE /xusers/secure/groups/{groupName}</span></abbr></a></li> <li><a href="#resource_XUserREST_secureGetXGroup_GET"><abbr title="GET /xusers/secure/groups/{id}"><span class="sideoverflow">GET /xusers/secure/groups/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_secureUpdateXGroup_PUT"><abbr title="PUT /xusers/secure/groups/{id}"><span class="sideoverflow">PUT /xusers/secure/groups/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_modifyUserActiveStatus_PUT"><abbr title="PUT /xusers/secure/users/activestatus"><span class="sideoverflow">PUT /xusers/secure/users/activestatus</span></abbr></a></li> <li><a href="#resource_XUserREST_deleteUsersByUserName_DELETE"><abbr title="DELETE /xusers/secure/users/delete"><span class="sideoverflow">DELETE /xusers/secure/users/delete</span></abbr></a></li> <li><a href="#resource_XUserREST_modifyUserVisibility_PUT"><abbr title="PUT /xusers/secure/users/visibility"><span class="sideoverflow">PUT /xusers/secure/users/visibility</span></abbr></a></li> <li><a href="#resource_XUserREST_secureGetXUser_GET"><abbr title="GET /xusers/secure/users/{id}"><span class="sideoverflow">GET /xusers/secure/users/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_secureUpdateXUser_PUT"><abbr title="PUT /xusers/secure/users/{id}"><span class="sideoverflow">PUT /xusers/secure/users/{id}</span></abbr></a></li> <li><a href="#resource_XUserREST_deleteSingleUserByUserName_DELETE"><abbr title="DELETE /xusers/secure/users/{userName}"><span class="sideoverflow">DELETE /xusers/secure/users/{userName}</span></abbr></a></li> <li><a href="#resource_XUserREST_updateDeletedGroups_POST"><abbr title="POST /xusers/ugsync/groups/visibility"><span class="sideoverflow">POST /xusers/ugsync/groups/visibility</span></abbr></a></li> <li><a href="#resource_XUserREST_updateDeletedUsers_POST"><abbr title="POST /xusers/ugsync/users/visibility"><span class="sideoverflow">POST /xusers/ugsync/users/visibility</span></abbr></a></li> <li><a href="#resource_XUserREST_deleteXUserByUserName_DELETE"><abbr title="DELETE /xusers/users/userName/{userName}"><span class="sideoverflow">DELETE /xusers/users/userName/{userName}</span></abbr></a></li> <li><a href="#resource_XUserREST_getXUserByUserName_GET"><abbr title="GET /xusers/users/userName/{userName}"><span class="sideoverflow">GET /xusers/users/userName/{userName}</span></abbr></a></li> <li><a href="#resource_XUserREST_deleteXGroupAndXUser_DELETE"><abbr title="DELETE /xusers/group/{groupName}/user/{userName}"><span class="sideoverflow">DELETE /xusers/group/{groupName}/user/{userName}</span></abbr></a></li> <li><a href="#resource_XUserREST_deleteSingleGroupByGroupId_DELETE"><abbr title="DELETE /xusers/secure/groups/id/{groupId}"><span class="sideoverflow">DELETE /xusers/secure/groups/id/{groupId}</span></abbr></a></li> <li><a href="#resource_XUserREST_getUserRolesByExternalID_GET"><abbr title="GET /xusers/secure/users/external/{userId}"><span class="sideoverflow">GET /xusers/secure/users/external/{userId}</span></abbr></a></li> <li><a href="#resource_XUserREST_deleteSingleUserByUserId_DELETE"><abbr title="DELETE /xusers/secure/users/id/{userId}"><span class="sideoverflow">DELETE /xusers/secure/users/id/{userId}</span></abbr></a></li> <li><a href="#resource_XUserREST_setUserRolesByExternalID_PUT"><abbr title="PUT /xusers/secure/users/roles/{userId}"><span class="sideoverflow">PUT /xusers/secure/users/roles/{userId}</span></abbr></a></li> <li><a href="#resource_XUserREST_getUserRolesByName_GET"><abbr title="GET /xusers/secure/users/roles/userName/{userName}"><span class="sideoverflow">GET /xusers/secure/users/roles/userName/{userName}</span></abbr></a></li> <li><a href="#resource_XUserREST_setUserRolesByName_PUT"><abbr title="PUT /xusers/secure/users/roles/userName/{userName}"><span class="sideoverflow">PUT /xusers/secure/users/roles/userName/{userName}</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_XUserREST.html">XUserREST</a></li> </ol> <h1 class="page-header">XUserREST <small>Resource</small></h1> <p></p> <div id="resource_XUserREST_searchXAuditMaps_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/auditmaps <a href="../xusers/auditmaps" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p>Implements the traditional search functionalities for XAuditMaps</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 "Accept: application/json" 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_VXAuditMapList.html">VXAuditMapList</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 "Accept: application/xml" 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_VXAuditMapList.html">VXAuditMapList</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 /xusers/auditmaps 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"> { "vXAuditMaps" : [ { "resourceId" : 12345, "groupId" : 12345, "userId" : 12345, "auditType" : 12345, "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "resourceId" : 12345, "groupId" : 12345, "userId" : 12345, "auditType" : 12345, "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_createXAuditMap_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/auditmaps <a href="../xusers/auditmaps" 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 "Content-Type: application/json" 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_VXAuditMap.html">VXAuditMap</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXAuditMap.html">VXAuditMap</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 "Accept: application/json" 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_VXAuditMap.html">VXAuditMap</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 "Accept: application/xml" 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_VXAuditMap.html">VXAuditMap</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 /xusers/auditmaps Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "resourceId" : 12345, "groupId" : 12345, "userId" : 12345, "auditType" : 12345, "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </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"> { "resourceId" : 12345, "groupId" : 12345, "userId" : 12345, "auditType" : 12345, "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_updateXAuditMap_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/xusers/auditmaps <a href="../xusers/auditmaps" 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 "Content-Type: application/json" 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_VXAuditMap.html">VXAuditMap</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXAuditMap.html">VXAuditMap</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 "Accept: application/json" 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_VXAuditMap.html">VXAuditMap</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 "Accept: application/xml" 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_VXAuditMap.html">VXAuditMap</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 /xusers/auditmaps Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "resourceId" : 12345, "groupId" : 12345, "userId" : 12345, "auditType" : 12345, "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </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"> { "resourceId" : 12345, "groupId" : 12345, "userId" : 12345, "auditType" : 12345, "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getAuthSessions_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/authSessions <a href="../xusers/authSessions" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></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 "Accept: application/json" 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_VXAuthSessionList.html">VXAuthSessionList</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 "Accept: application/xml" 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_VXAuthSessionList.html">VXAuthSessionList</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 /xusers/authSessions 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"> { "vXAuthSessions" : [ { "loginId" : "...", "userId" : 12345, "emailAddress" : "...", "isTestUser" : true, "firstName" : "...", "lastName" : "...", "publicScreenName" : "...", "familyScreenName" : "...", "authTime" : 12345, "authStatus" : 12345, "authType" : 12345, "authProvider" : 12345, "deviceType" : 12345, "requestIP" : "...", "cityName" : "...", "stateName" : "...", "countryName" : "...", "requestUserAgent" : "...", "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "loginId" : "...", "userId" : 12345, "emailAddress" : "...", "isTestUser" : true, "firstName" : "...", "lastName" : "...", "publicScreenName" : "...", "familyScreenName" : "...", "authTime" : 12345, "authStatus" : 12345, "authType" : 12345, "authProvider" : 12345, "deviceType" : 12345, "requestIP" : "...", "cityName" : "...", "stateName" : "...", "countryName" : "...", "requestUserAgent" : "...", "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_searchXGroupGroups_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/groupgroups <a href="../xusers/groupgroups" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p>Implements the traditional search functionalities for XGroupGroups</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 "Accept: application/json" 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_VXGroupGroupList.html">VXGroupGroupList</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 "Accept: application/xml" 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_VXGroupGroupList.html">VXGroupGroupList</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 /xusers/groupgroups 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"> { "vXGroupGroups" : [ { "name" : "...", "parentGroupId" : 12345, "groupId" : 12345, "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "name" : "...", "parentGroupId" : 12345, "groupId" : 12345, "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_createXGroupGroup_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/groupgroups <a href="../xusers/groupgroups" 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 "Content-Type: application/json" 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_VXGroupGroup.html">VXGroupGroup</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXGroupGroup.html">VXGroupGroup</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 "Accept: application/json" 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_VXGroupGroup.html">VXGroupGroup</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 "Accept: application/xml" 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_VXGroupGroup.html">VXGroupGroup</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 /xusers/groupgroups Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "name" : "...", "parentGroupId" : 12345, "groupId" : 12345, "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </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"> { "name" : "...", "parentGroupId" : 12345, "groupId" : 12345, "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_updateXGroupGroup_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/xusers/groupgroups <a href="../xusers/groupgroups" 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 "Content-Type: application/json" 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_VXGroupGroup.html">VXGroupGroup</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXGroupGroup.html">VXGroupGroup</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 "Accept: application/json" 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_VXGroupGroup.html">VXGroupGroup</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 "Accept: application/xml" 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_VXGroupGroup.html">VXGroupGroup</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 /xusers/groupgroups Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "name" : "...", "parentGroupId" : 12345, "groupId" : 12345, "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </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"> { "name" : "...", "parentGroupId" : 12345, "groupId" : 12345, "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_searchXGroups_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/groups <a href="../xusers/groups" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p>Implements the traditional search functionalities for XGroups</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 "Accept: application/json" 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_VXGroupList.html">VXGroupList</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 "Accept: application/xml" 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_VXGroupList.html">VXGroupList</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 /xusers/groups 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"> { "vXGroups" : [ { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_createXGroup_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/groups <a href="../xusers/groups" 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 "Content-Type: application/json" 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_VXGroup.html">VXGroup</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXGroup.html">VXGroup</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 "Accept: application/json" 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_VXGroup.html">VXGroup</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 "Accept: application/xml" 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_VXGroup.html">VXGroup</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 /xusers/groups Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </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"> { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_updateXGroup_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/xusers/groups <a href="../xusers/groups" 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 "Content-Type: application/json" 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_VXGroup.html">VXGroup</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXGroup.html">VXGroup</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 "Accept: application/json" 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_VXGroup.html">VXGroup</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 "Accept: application/xml" 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_VXGroup.html">VXGroup</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 /xusers/groups Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </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"> { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_searchXGroupUsers_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/groupusers <a href="../xusers/groupusers" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p>Implements the traditional search functionalities for XGroupUsers</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 "Accept: application/json" 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_VXGroupUserList.html">VXGroupUserList</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 "Accept: application/xml" 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_VXGroupUserList.html">VXGroupUserList</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 /xusers/groupusers 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"> { "vXGroupUsers" : [ { "name" : "...", "parentGroupId" : 12345, "userId" : 12345, "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "name" : "...", "parentGroupId" : 12345, "userId" : 12345, "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_createXGroupUser_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/groupusers <a href="../xusers/groupusers" 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 "Content-Type: application/json" 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_VXGroupUser.html">VXGroupUser</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXGroupUser.html">VXGroupUser</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 "Accept: application/json" 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_VXGroupUser.html">VXGroupUser</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 "Accept: application/xml" 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_VXGroupUser.html">VXGroupUser</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 /xusers/groupusers Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "name" : "...", "parentGroupId" : 12345, "userId" : 12345, "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </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"> { "name" : "...", "parentGroupId" : 12345, "userId" : 12345, "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_updateXGroupUser_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/xusers/groupusers <a href="../xusers/groupusers" 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 "Content-Type: application/json" 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_VXGroupUser.html">VXGroupUser</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXGroupUser.html">VXGroupUser</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 "Accept: application/json" 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_VXGroupUser.html">VXGroupUser</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 "Accept: application/xml" 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_VXGroupUser.html">VXGroupUser</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 /xusers/groupusers Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "name" : "...", "parentGroupId" : 12345, "userId" : 12345, "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </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"> { "name" : "...", "parentGroupId" : 12345, "userId" : 12345, "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_searchXModuleDef_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/permission <a href="../xusers/permission" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></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 "Accept: application/json" 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_VXModuleDefList.html">VXModuleDefList</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 "Accept: application/xml" 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_VXModuleDefList.html">VXModuleDefList</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 /xusers/permission 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"> { "vXModuleDef" : [ { "userPermList" : [ { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "groupPermList" : [ { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "id" : 12345, "createTime" : 12345, "updateTime" : 12345, "addedById" : 12345, "updatedById" : 12345, "module" : "...", "url" : "...", "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "...", "myClassType" : 12345 }, { "userPermList" : [ { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "groupPermList" : [ { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "id" : 12345, "createTime" : 12345, "updateTime" : 12345, "addedById" : 12345, "updatedById" : 12345, "module" : "...", "url" : "...", "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "...", "myClassType" : 12345 } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_createXModuleDefPermission_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/permission <a href="../xusers/permission" 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 "Content-Type: application/json" 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_VXModuleDef.html">VXModuleDef</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXModuleDef.html">VXModuleDef</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 "Accept: application/json" 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_VXModuleDef.html">VXModuleDef</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 "Accept: application/xml" 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_VXModuleDef.html">VXModuleDef</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 /xusers/permission Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "userPermList" : [ { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "groupPermList" : [ { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "id" : 12345, "createTime" : 12345, "updateTime" : 12345, "addedById" : 12345, "updatedById" : 12345, "module" : "...", "url" : "...", "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "...", "myClassType" : 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"> { "userPermList" : [ { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "groupPermList" : [ { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "id" : 12345, "createTime" : 12345, "updateTime" : 12345, "addedById" : 12345, "updatedById" : 12345, "module" : "...", "url" : "...", "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "...", "myClassType" : 12345 } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_searchXPermMaps_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/permmaps <a href="../xusers/permmaps" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p>Implements the traditional search functionalities for XPermMaps</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 "Accept: application/json" 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_VXPermMapList.html">VXPermMapList</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 "Accept: application/xml" 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_VXPermMapList.html">VXPermMapList</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 /xusers/permmaps 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"> { "vXPermMaps" : [ { "permGroup" : "...", "resourceId" : 12345, "groupId" : 12345, "userId" : 12345, "permFor" : 12345, "permType" : 12345, "grantOrRevoke" : true, "groupName" : "...", "userName" : "...", "isRecursive" : 12345, "isWildCard" : true, "ipAddress" : "...", "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "permGroup" : "...", "resourceId" : 12345, "groupId" : 12345, "userId" : 12345, "permFor" : 12345, "permType" : 12345, "grantOrRevoke" : true, "groupName" : "...", "userName" : "...", "isRecursive" : 12345, "isWildCard" : true, "ipAddress" : "...", "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_createXPermMap_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/permmaps <a href="../xusers/permmaps" 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 "Content-Type: application/json" 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_VXPermMap.html">VXPermMap</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXPermMap.html">VXPermMap</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 "Accept: application/json" 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_VXPermMap.html">VXPermMap</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 "Accept: application/xml" 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_VXPermMap.html">VXPermMap</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 /xusers/permmaps Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "permGroup" : "...", "resourceId" : 12345, "groupId" : 12345, "userId" : 12345, "permFor" : 12345, "permType" : 12345, "grantOrRevoke" : true, "groupName" : "...", "userName" : "...", "isRecursive" : 12345, "isWildCard" : true, "ipAddress" : "...", "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </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"> { "permGroup" : "...", "resourceId" : 12345, "groupId" : 12345, "userId" : 12345, "permFor" : 12345, "permType" : 12345, "grantOrRevoke" : true, "groupName" : "...", "userName" : "...", "isRecursive" : 12345, "isWildCard" : true, "ipAddress" : "...", "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_updateXPermMap_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/xusers/permmaps <a href="../xusers/permmaps" 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 "Content-Type: application/json" 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_VXPermMap.html">VXPermMap</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXPermMap.html">VXPermMap</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 "Accept: application/json" 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_VXPermMap.html">VXPermMap</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 "Accept: application/xml" 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_VXPermMap.html">VXPermMap</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 /xusers/permmaps Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "permGroup" : "...", "resourceId" : 12345, "groupId" : 12345, "userId" : 12345, "permFor" : 12345, "permType" : 12345, "grantOrRevoke" : true, "groupName" : "...", "userName" : "...", "isRecursive" : 12345, "isWildCard" : true, "ipAddress" : "...", "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </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"> { "permGroup" : "...", "resourceId" : 12345, "groupId" : 12345, "userId" : 12345, "permFor" : 12345, "permType" : 12345, "grantOrRevoke" : true, "groupName" : "...", "userName" : "...", "isRecursive" : 12345, "isWildCard" : true, "ipAddress" : "...", "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_searchXUsers_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/users <a href="../xusers/users" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p>Implements the traditional search functionalities for XUsers</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 "Accept: application/json" 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_VXUserList.html">VXUserList</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 "Accept: application/xml" 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_VXUserList.html">VXUserList</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 /xusers/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"> { "vXUsers" : [ { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_createXUser_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/users <a href="../xusers/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 "Content-Type: application/json" 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_VXUser.html">VXUser</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXUser.html">VXUser</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 "Accept: application/json" 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_VXUser.html">VXUser</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 "Accept: application/xml" 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_VXUser.html">VXUser</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 /xusers/users Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </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"> { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_updateXUser_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/xusers/users <a href="../xusers/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 "Content-Type: application/json" 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_VXUser.html">VXUser</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXUser.html">VXUser</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 "Accept: application/json" 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_VXUser.html">VXUser</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 "Accept: application/xml" 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_VXUser.html">VXUser</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 /xusers/users Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </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"> { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_countXAuditMaps_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/auditmaps/count <a href="../xusers/auditmaps/count" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></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 "Accept: application/json" 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_VXLong.html">VXLong</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 "Accept: application/xml" 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_VXLong.html">VXLong</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 /xusers/auditmaps/count 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"> { "value" : 12345, "myClassType" : 12345 } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_deleteXAuditMap_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/xusers/auditmaps/{id} <a href="../xusers/auditmaps/{id}" 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">id</span></td> <td>path</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-constraints">long</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> DELETE /xusers/auditmaps/{id} Content-Type: */* <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getXAuditMap_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/auditmaps/{id} <a href="../xusers/auditmaps/{id}" 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">id</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 "Accept: application/json" 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_VXAuditMap.html">VXAuditMap</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 "Accept: application/xml" 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_VXAuditMap.html">VXAuditMap</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 /xusers/auditmaps/{id} 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"> { "resourceId" : 12345, "groupId" : 12345, "userId" : 12345, "auditType" : 12345, "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getAuthSession_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/authSessions/info <a href="../xusers/authSessions/info" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></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 "Accept: application/json" 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_VXAuthSession.html">VXAuthSession</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 "Accept: application/xml" 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_VXAuthSession.html">VXAuthSession</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 /xusers/authSessions/info 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"> { "loginId" : "...", "userId" : 12345, "emailAddress" : "...", "isTestUser" : true, "firstName" : "...", "lastName" : "...", "publicScreenName" : "...", "familyScreenName" : "...", "authTime" : 12345, "authStatus" : 12345, "authType" : 12345, "authProvider" : 12345, "deviceType" : 12345, "requestIP" : "...", "cityName" : "...", "stateName" : "...", "countryName" : "...", "requestUserAgent" : "...", "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_countXGroupGroups_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/groupgroups/count <a href="../xusers/groupgroups/count" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></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 "Accept: application/json" 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_VXLong.html">VXLong</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 "Accept: application/xml" 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_VXLong.html">VXLong</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 /xusers/groupgroups/count 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"> { "value" : 12345, "myClassType" : 12345 } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_deleteXGroupGroup_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/xusers/groupgroups/{id} <a href="../xusers/groupgroups/{id}" 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">id</span></td> <td>path</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-constraints">long</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> DELETE /xusers/groupgroups/{id} Content-Type: */* <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getXGroupGroup_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/groupgroups/{id} <a href="../xusers/groupgroups/{id}" 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">id</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 "Accept: application/json" 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_VXGroupGroup.html">VXGroupGroup</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 "Accept: application/xml" 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_VXGroupGroup.html">VXGroupGroup</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 /xusers/groupgroups/{id} 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"> { "name" : "...", "parentGroupId" : 12345, "groupId" : 12345, "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_countXGroups_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/groups/count <a href="../xusers/groups/count" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></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 "Accept: application/json" 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_VXLong.html">VXLong</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 "Accept: application/xml" 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_VXLong.html">VXLong</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 /xusers/groups/count 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"> { "value" : 12345, "myClassType" : 12345 } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_createXGroupUserFromMap_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/groups/groupinfo <a href="../xusers/groups/groupinfo" 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 "Content-Type: application/json" 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_VXGroupUserInfo.html">VXGroupUserInfo</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXGroupUserInfo.html">VXGroupUserInfo</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 "Accept: application/json" 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_VXGroupUserInfo.html">VXGroupUserInfo</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 "Accept: application/xml" 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_VXGroupUserInfo.html">VXGroupUserInfo</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 /xusers/groups/groupinfo Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "xgroupInfo" : { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, "xuserInfo" : [ { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "...", "myClassType" : 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"> { "xgroupInfo" : { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, "xuserInfo" : [ { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "...", "myClassType" : 12345 } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_deleteXGroup_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/xusers/groups/{id} <a href="../xusers/groups/{id}" 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">id</span></td> <td>path</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-constraints">long</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> DELETE /xusers/groups/{id} Content-Type: */* <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getXGroup_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/groups/{id} <a href="../xusers/groups/{id}" 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">id</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 "Accept: application/json" 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_VXGroup.html">VXGroup</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 "Accept: application/xml" 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_VXGroup.html">VXGroup</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 /xusers/groups/{id} 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"> { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_countXGroupUsers_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/groupusers/count <a href="../xusers/groupusers/count" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></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 "Accept: application/json" 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_VXLong.html">VXLong</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 "Accept: application/xml" 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_VXLong.html">VXLong</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 /xusers/groupusers/count 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"> { "value" : 12345, "myClassType" : 12345 } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_deleteXGroupUser_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/xusers/groupusers/{id} <a href="../xusers/groupusers/{id}" 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">id</span></td> <td>path</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-constraints">long</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> DELETE /xusers/groupusers/{id} Content-Type: */* <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getXGroupUser_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/groupusers/{id} <a href="../xusers/groupusers/{id}" 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">id</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 "Accept: application/json" 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_VXGroupUser.html">VXGroupUser</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 "Accept: application/xml" 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_VXGroupUser.html">VXGroupUser</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 /xusers/groupusers/{id} 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"> { "name" : "...", "parentGroupId" : 12345, "userId" : 12345, "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getGroupsLookup_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/lookup/groups <a href="../xusers/lookup/groups" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></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 "Accept: application/json" 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_VXStringList.html">VXStringList</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 "Accept: application/xml" 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_VXStringList.html">VXStringList</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 /xusers/lookup/groups 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"> { "vXStrings" : [ { "value" : "...", "myClassType" : 12345 }, { "value" : "...", "myClassType" : 12345 } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getUsersLookup_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/lookup/users <a href="../xusers/lookup/users" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></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 "Accept: application/json" 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_VXStringList.html">VXStringList</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 "Accept: application/xml" 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_VXStringList.html">VXStringList</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 /xusers/lookup/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"> { "vXStrings" : [ { "value" : "...", "myClassType" : 12345 }, { "value" : "...", "myClassType" : 12345 } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_countXModuleDef_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/permission/count <a href="../xusers/permission/count" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></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 "Accept: application/json" 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_VXLong.html">VXLong</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 "Accept: application/xml" 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_VXLong.html">VXLong</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 /xusers/permission/count 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"> { "value" : 12345, "myClassType" : 12345 } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_searchXGroupPermission_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/permission/group <a href="../xusers/permission/group" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></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 "Accept: application/json" 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_VXGroupPermissionList.html">VXGroupPermissionList</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 "Accept: application/xml" 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_VXGroupPermissionList.html">VXGroupPermissionList</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 /xusers/permission/group 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"> { "vXGroupPermission" : [ { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_createXGroupPermission_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/permission/group <a href="../xusers/permission/group" 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 "Content-Type: application/json" 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_VXGroupPermission.html">VXGroupPermission</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXGroupPermission.html">VXGroupPermission</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 "Accept: application/json" 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_VXGroupPermission.html">VXGroupPermission</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 "Accept: application/xml" 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_VXGroupPermission.html">VXGroupPermission</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 /xusers/permission/group Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </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"> { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_searchXUserPermission_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/permission/user <a href="../xusers/permission/user" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></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 "Accept: application/json" 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_VXUserPermissionList.html">VXUserPermissionList</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 "Accept: application/xml" 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_VXUserPermissionList.html">VXUserPermissionList</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 /xusers/permission/user 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"> { "vXUserPermission" : [ { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_createXUserPermission_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/permission/user <a href="../xusers/permission/user" 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 "Content-Type: application/json" 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_VXUserPermission.html">VXUserPermission</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXUserPermission.html">VXUserPermission</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 "Accept: application/json" 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_VXUserPermission.html">VXUserPermission</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 "Accept: application/xml" 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_VXUserPermission.html">VXUserPermission</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 /xusers/permission/user Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </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"> { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_deleteXModuleDefPermission_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/xusers/permission/{id} <a href="../xusers/permission/{id}" 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">id</span></td> <td>path</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-constraints">long</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> DELETE /xusers/permission/{id} Content-Type: */* <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getXModuleDefPermission_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/permission/{id} <a href="../xusers/permission/{id}" 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">id</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 "Accept: application/json" 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_VXModuleDef.html">VXModuleDef</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 "Accept: application/xml" 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_VXModuleDef.html">VXModuleDef</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 /xusers/permission/{id} 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"> { "userPermList" : [ { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "groupPermList" : [ { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "id" : 12345, "createTime" : 12345, "updateTime" : 12345, "addedById" : 12345, "updatedById" : 12345, "module" : "...", "url" : "...", "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "...", "myClassType" : 12345 } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_updateXModuleDefPermission_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/xusers/permission/{id} <a href="../xusers/permission/{id}" 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 "Content-Type: application/json" 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_VXModuleDef.html">VXModuleDef</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXModuleDef.html">VXModuleDef</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 "Accept: application/json" 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_VXModuleDef.html">VXModuleDef</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 "Accept: application/xml" 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_VXModuleDef.html">VXModuleDef</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 /xusers/permission/{id} Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "userPermList" : [ { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "groupPermList" : [ { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "id" : 12345, "createTime" : 12345, "updateTime" : 12345, "addedById" : 12345, "updatedById" : 12345, "module" : "...", "url" : "...", "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "...", "myClassType" : 12345 } </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"> { "userPermList" : [ { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "groupPermList" : [ { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "id" : 12345, "createTime" : 12345, "updateTime" : 12345, "addedById" : 12345, "updatedById" : 12345, "module" : "...", "url" : "...", "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "...", "myClassType" : 12345 } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_countXPermMaps_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/permmaps/count <a href="../xusers/permmaps/count" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></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 "Accept: application/json" 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_VXLong.html">VXLong</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 "Accept: application/xml" 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_VXLong.html">VXLong</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 /xusers/permmaps/count 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"> { "value" : 12345, "myClassType" : 12345 } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_deleteXPermMap_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/xusers/permmaps/{id} <a href="../xusers/permmaps/{id}" 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">id</span></td> <td>path</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-constraints">long</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> DELETE /xusers/permmaps/{id} Content-Type: */* <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getXPermMap_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/permmaps/{id} <a href="../xusers/permmaps/{id}" 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">id</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 "Accept: application/json" 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_VXPermMap.html">VXPermMap</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 "Accept: application/xml" 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_VXPermMap.html">VXPermMap</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 /xusers/permmaps/{id} 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"> { "permGroup" : "...", "resourceId" : 12345, "groupId" : 12345, "userId" : 12345, "permFor" : 12345, "permType" : 12345, "grantOrRevoke" : true, "groupName" : "...", "userName" : "...", "isRecursive" : 12345, "isWildCard" : true, "ipAddress" : "...", "myClassType" : 12345, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_secureCreateXGroup_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/secure/groups <a href="../xusers/secure/groups" 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 "Content-Type: application/json" 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_VXGroup.html">VXGroup</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXGroup.html">VXGroup</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 "Accept: application/json" 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_VXGroup.html">VXGroup</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 "Accept: application/xml" 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_VXGroup.html">VXGroup</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 /xusers/secure/groups Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </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"> { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_secureCreateXUser_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/secure/users <a href="../xusers/secure/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 "Content-Type: application/json" 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_VXUser.html">VXUser</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXUser.html">VXUser</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 "Accept: application/json" 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_VXUser.html">VXUser</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 "Accept: application/xml" 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_VXUser.html">VXUser</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 /xusers/secure/users Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </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"> { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_postUserGroupAuditInfo_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/ugsync/auditinfo <a href="../xusers/ugsync/auditinfo" 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 "Content-Type: application/json" 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_VXUgsyncAuditInfo.html">VXUgsyncAuditInfo</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXUgsyncAuditInfo.html">VXUgsyncAuditInfo</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 "Accept: application/json" 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_VXUgsyncAuditInfo.html">VXUgsyncAuditInfo</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 "Accept: application/xml" 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_VXUgsyncAuditInfo.html">VXUgsyncAuditInfo</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 /xusers/ugsync/auditinfo Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "eventTime" : 12345, "userName" : "...", "noOfNewUsers" : 12345, "noOfModifiedUsers" : 12345, "noOfNewGroups" : 12345, "noOfModifiedGroups" : 12345, "syncSource" : "...", "ldapSyncSourceInfo" : { "ldapUrl" : "...", "userSearchFilter" : "...", "groupSearchFilter" : "...", "groupHierarchyLevel" : "...", "totalUsersSynced" : 12345, "totalGroupsSynced" : 12345, "groupSearchFirstEnabled" : "...", "groupSearchEnabled" : "...", "userSearchEnabled" : "...", "totalUsersDeleted" : 12345, "totalGroupsDeleted" : 12345 }, "fileSyncSourceInfo" : { "fileName" : "...", "syncTime" : "...", "lastModified" : "...", "totalUsersSynced" : 12345, "totalGroupsSynced" : 12345, "totalUsersDeleted" : 12345, "totalGroupsDeleted" : 12345 }, "unixSyncSourceInfo" : { "fileName" : "...", "syncTime" : "...", "lastModified" : "...", "unixBackend" : "...", "minUserId" : "...", "minGroupId" : "...", "totalUsersSynced" : 12345, "totalGroupsSynced" : 12345, "totalUsersDeleted" : 12345, "totalGroupsDeleted" : 12345 }, "sessionId" : "...", "syncSourceInfo" : { "property1" : "...", "property2" : "..." }, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "...", "myClassType" : 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"> { "eventTime" : 12345, "userName" : "...", "noOfNewUsers" : 12345, "noOfModifiedUsers" : 12345, "noOfNewGroups" : 12345, "noOfModifiedGroups" : 12345, "syncSource" : "...", "ldapSyncSourceInfo" : { "ldapUrl" : "...", "userSearchFilter" : "...", "groupSearchFilter" : "...", "groupHierarchyLevel" : "...", "totalUsersSynced" : 12345, "totalGroupsSynced" : 12345, "groupSearchFirstEnabled" : "...", "groupSearchEnabled" : "...", "userSearchEnabled" : "...", "totalUsersDeleted" : 12345, "totalGroupsDeleted" : 12345 }, "fileSyncSourceInfo" : { "fileName" : "...", "syncTime" : "...", "lastModified" : "...", "totalUsersSynced" : 12345, "totalGroupsSynced" : 12345, "totalUsersDeleted" : 12345, "totalGroupsDeleted" : 12345 }, "unixSyncSourceInfo" : { "fileName" : "...", "syncTime" : "...", "lastModified" : "...", "unixBackend" : "...", "minUserId" : "...", "minGroupId" : "...", "totalUsersSynced" : 12345, "totalGroupsSynced" : 12345, "totalUsersDeleted" : 12345, "totalGroupsDeleted" : 12345 }, "sessionId" : "...", "syncSourceInfo" : { "property1" : "...", "property2" : "..." }, "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "...", "myClassType" : 12345 } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_addOrUpdateGroups_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/ugsync/groups <a href="../xusers/ugsync/groups" 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 "Content-Type: application/json" 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_VXGroupList.html">VXGroupList</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXGroupList.html">VXGroupList</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 "Accept: application/json" 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">number (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 "Accept: application/xml" 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">int (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 /xusers/ugsync/groups Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "vXGroups" : [ { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </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-txt"> ... </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getAllGroupUsers_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/ugsync/groupusers <a href="../xusers/ugsync/groupusers" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></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 "Accept: application/json" 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">map of array of 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 "Accept: application/xml" 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">(custom) (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 /xusers/ugsync/groupusers 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_XUserREST_addOrUpdateGroupUsersList_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/ugsync/groupusers <a href="../xusers/ugsync/groupusers" 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 "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> <td><span class="datatype-reference">array of <a href="json_GroupUserInfo.html">GroupUserInfo</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference">list of <a href="xml_ns0_groupUserInfo.html">groupUserInfo</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 "Accept: application/json" 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">number (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 "Accept: application/xml" 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">int (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 /xusers/ugsync/groupusers Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> [ { "groupName" : "...", "delUsers" : [ "...", "..." ], "addUsers" : [ "...", "..." ] } ] </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-txt"> ... </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_addOrUpdateUsers_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/ugsync/users <a href="../xusers/ugsync/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 "Content-Type: application/json" 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_VXUserList.html">VXUserList</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXUserList.html">VXUserList</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 "Accept: application/json" 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 "Accept: application/xml" 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> POST /xusers/ugsync/users Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "vXUsers" : [ { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </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-txt"> ... </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_countXUsers_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/users/count <a href="../xusers/users/count" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></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 "Accept: application/json" 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_VXLong.html">VXLong</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 "Accept: application/xml" 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_VXLong.html">VXLong</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 /xusers/users/count 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"> { "value" : 12345, "myClassType" : 12345 } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_createExternalUser_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/users/external <a href="../xusers/users/external" 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 "Content-Type: application/json" 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_VXUser.html">VXUser</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXUser.html">VXUser</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 "Accept: application/json" 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_VXUser.html">VXUser</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 "Accept: application/xml" 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_VXUser.html">VXUser</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 /xusers/users/external Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </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"> { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_setXUserRolesByName_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/users/roleassignments <a href="../xusers/users/roleassignments" 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 "Content-Type: application/json" 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_UsersGroupRoleAssignments.html">UsersGroupRoleAssignments</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_usersGroupRoleAssignments.html">usersGroupRoleAssignments</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 "Accept: application/json" 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">array of 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 "Accept: application/xml" 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">list of 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> POST /xusers/users/roleassignments Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "userRoleAssignments" : { "property1" : "...", "property2" : "..." }, "groupRoleAssignments" : { "property1" : "...", "property2" : "..." }, "users" : [ "...", "..." ] } </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-txt"> ... </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_createXUserGroupFromMap_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/users/userinfo <a href="../xusers/users/userinfo" 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 "Content-Type: application/json" 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_VXUserGroupInfo.html">VXUserGroupInfo</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXUserGroupInfo.html">VXUserGroupInfo</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 "Accept: application/json" 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_VXUserGroupInfo.html">VXUserGroupInfo</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 "Accept: application/xml" 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_VXUserGroupInfo.html">VXUserGroupInfo</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 /xusers/users/userinfo Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "xuserInfo" : { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, "xgroupInfo" : [ { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "...", "myClassType" : 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"> { "xuserInfo" : { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, "xgroupInfo" : [ { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "...", "myClassType" : 12345 } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_deleteXUser_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/xusers/users/{id} <a href="../xusers/users/{id}" 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">id</span></td> <td>path</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-constraints">long</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> DELETE /xusers/users/{id} Content-Type: */* <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getXUser_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/users/{id} <a href="../xusers/users/{id}" 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">id</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 "Accept: application/json" 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_VXUser.html">VXUser</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 "Accept: application/xml" 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_VXUser.html">VXUser</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 /xusers/users/{id} 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"> { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getXGroupUsers_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/{groupId}/users <a href="../xusers/{groupId}/users" 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">groupId</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 "Accept: application/json" 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_VXUserList.html">VXUserList</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 "Accept: application/xml" 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_VXUserList.html">VXUserList</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 /xusers/{groupId}/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"> { "vXUsers" : [ { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getXUserGroups_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/{userId}/groups <a href="../xusers/{userId}/groups" 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-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 "Accept: application/json" 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_VXGroupList.html">VXGroupList</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 "Accept: application/xml" 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_VXGroupList.html">VXGroupList</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 /xusers/{userId}/groups 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"> { "vXGroups" : [ { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_deleteXGroupByGroupName_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/xusers/groups/groupName/{groupName} <a href="../xusers/groups/groupName/{groupName}" 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">groupName</span></td> <td>path</td> <td><span class="parameter-description"></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> DELETE /xusers/groups/groupName/{groupName} Content-Type: */* <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getXGroupByGroupName_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/groups/groupName/{groupName} <a href="../xusers/groups/groupName/{groupName}" 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">groupName</span></td> <td>path</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 "Accept: application/json" 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_VXGroup.html">VXGroup</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 "Accept: application/xml" 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_VXGroup.html">VXGroup</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 /xusers/groups/groupName/{groupName} 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"> { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getXGroupUsersByGroupName_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/groupusers/groupName/{groupName} <a href="../xusers/groupusers/groupName/{groupName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p>Implements the traditional search functionalities for XGroupUsers by Group name</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">groupName</span></td> <td>path</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 "Accept: application/json" 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_VXGroupUserInfo.html">VXGroupUserInfo</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 "Accept: application/xml" 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_VXGroupUserInfo.html">VXGroupUserInfo</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 /xusers/groupusers/groupName/{groupName} 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"> { "xgroupInfo" : { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, "xuserInfo" : [ { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." }, { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } ], "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "...", "myClassType" : 12345 } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_countXGroupPermission_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/permission/group/count <a href="../xusers/permission/group/count" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></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 "Accept: application/json" 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_VXLong.html">VXLong</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 "Accept: application/xml" 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_VXLong.html">VXLong</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 /xusers/permission/group/count 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"> { "value" : 12345, "myClassType" : 12345 } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_deleteXGroupPermission_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/xusers/permission/group/{id} <a href="../xusers/permission/group/{id}" 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">id</span></td> <td>path</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-constraints">long</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> DELETE /xusers/permission/group/{id} Content-Type: */* <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getXGroupPermission_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/permission/group/{id} <a href="../xusers/permission/group/{id}" 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">id</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 "Accept: application/json" 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_VXGroupPermission.html">VXGroupPermission</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 "Accept: application/xml" 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_VXGroupPermission.html">VXGroupPermission</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 /xusers/permission/group/{id} 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"> { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_updateXGroupPermission_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/xusers/permission/group/{id} <a href="../xusers/permission/group/{id}" 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 "Content-Type: application/json" 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_VXGroupPermission.html">VXGroupPermission</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXGroupPermission.html">VXGroupPermission</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 "Accept: application/json" 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_VXGroupPermission.html">VXGroupPermission</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 "Accept: application/xml" 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_VXGroupPermission.html">VXGroupPermission</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 /xusers/permission/group/{id} Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </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"> { "id" : 12345, "groupId" : 12345, "groupName" : "...", "moduleId" : 12345, "isAllowed" : 12345, "moduleName" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_countXUserPermission_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/permission/user/count <a href="../xusers/permission/user/count" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></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 "Accept: application/json" 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_VXLong.html">VXLong</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 "Accept: application/xml" 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_VXLong.html">VXLong</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 /xusers/permission/user/count 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"> { "value" : 12345, "myClassType" : 12345 } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_deleteXUserPermission_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/xusers/permission/user/{id} <a href="../xusers/permission/user/{id}" 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">id</span></td> <td>path</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-constraints">long</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> DELETE /xusers/permission/user/{id} Content-Type: */* <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getXUserPermission_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/permission/user/{id} <a href="../xusers/permission/user/{id}" 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">id</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 "Accept: application/json" 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_VXUserPermission.html">VXUserPermission</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 "Accept: application/xml" 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_VXUserPermission.html">VXUserPermission</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 /xusers/permission/user/{id} 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"> { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_updateXUserPermission_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/xusers/permission/user/{id} <a href="../xusers/permission/user/{id}" 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 "Content-Type: application/json" 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_VXUserPermission.html">VXUserPermission</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXUserPermission.html">VXUserPermission</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 "Accept: application/json" 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_VXUserPermission.html">VXUserPermission</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 "Accept: application/xml" 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_VXUserPermission.html">VXUserPermission</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 /xusers/permission/user/{id} Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </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"> { "id" : 12345, "userId" : 12345, "moduleId" : 12345, "isAllowed" : 12345, "userName" : "...", "moduleName" : "...", "loginId" : "...", "myClassType" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getSecureRangerUserStoreIfUpdated_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/secure/download/{serviceName} <a href="../xusers/secure/download/{serviceName}" 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>default</th> <th>constraints</th> </tr> </thead> <tbody> <tr> <td><span class="parameter-name">serviceName</span></td> <td>path</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value"> </span></td> <td><span class="parameter-constraints"> </span></td> </tr> <tr> <td><span class="parameter-name">clusterName</span></td> <td>query</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value"></span></td> <td><span class="parameter-constraints"> </span></td> </tr> <tr> <td><span class="parameter-name">lastActivationTime</span></td> <td>query</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value">0</span></td> <td><span class="parameter-constraints">long</span></td> </tr> <tr> <td><span class="parameter-name">lastKnownUserStoreVersion</span></td> <td>query</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value"> </span></td> <td><span class="parameter-constraints">long</span></td> </tr> <tr> <td><span class="parameter-name">pluginCapabilities</span></td> <td>query</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value"></span></td> <td><span class="parameter-constraints"> </span></td> </tr> <tr> <td><span class="parameter-name">pluginId</span></td> <td>query</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value"> </span></td> <td><span class="parameter-constraints"> </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 "Accept: application/json" 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_RangerUserStore.html">RangerUserStore</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 "Accept: application/xml" 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_rangerUserStore.html">rangerUserStore</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 /xusers/secure/download/{serviceName} 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"> { "groupCloudIdMapping" : { "property1" : "...", "property2" : "..." }, "userAttrMapping" : { "property1" : { }, "property2" : { } }, "userCloudIdMapping" : { "property1" : "...", "property2" : "..." }, "userStoreUpdateTime" : 12345, "userGroupMapping" : { "property1" : [ "...", "..." ], "property2" : [ "...", "..." ] }, "groupAttrMapping" : { "property1" : { }, "property2" : { } }, "userStoreVersion" : 12345 } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_deleteGroupsByGroupName_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/xusers/secure/groups/delete <a href="../xusers/secure/groups/delete" 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 "Content-Type: application/json" 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 "Content-Type: application/xml" 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> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> DELETE /xusers/secure/groups/delete Content-Type: application/json <code class="prettyprint language-js"> { "vXStrings" : [ { "value" : "...", "myClassType" : 12345 }, { "value" : "...", "myClassType" : 12345 } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_XUserREST_modifyGroupsVisibility_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/xusers/secure/groups/visibility <a href="../xusers/secure/groups/visibility" 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 "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> <td><span class="datatype-reference">map of number (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference">(custom) (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 /xusers/secure/groups/visibility Content-Type: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_XUserREST_deleteSingleGroupByGroupName_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/xusers/secure/groups/{groupName} <a href="../xusers/secure/groups/{groupName}" 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">groupName</span></td> <td>path</td> <td><span class="parameter-description"></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> DELETE /xusers/secure/groups/{groupName} Content-Type: */* <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_XUserREST_secureGetXGroup_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/secure/groups/{id} <a href="../xusers/secure/groups/{id}" 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">id</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 "Accept: application/json" 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_VXGroup.html">VXGroup</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 "Accept: application/xml" 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_VXGroup.html">VXGroup</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 /xusers/secure/groups/{id} 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"> { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_secureUpdateXGroup_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/xusers/secure/groups/{id} <a href="../xusers/secure/groups/{id}" 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 "Content-Type: application/json" 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_VXGroup.html">VXGroup</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXGroup.html">VXGroup</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 "Accept: application/json" 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_VXGroup.html">VXGroup</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 "Accept: application/xml" 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_VXGroup.html">VXGroup</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 /xusers/secure/groups/{id} Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </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"> { "name" : "...", "description" : "...", "groupType" : 12345, "credStoreId" : 12345, "isVisible" : 12345, "myClassType" : 12345, "groupSource" : 12345, "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_modifyUserActiveStatus_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/xusers/secure/users/activestatus <a href="../xusers/secure/users/activestatus" 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 "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> <td><span class="datatype-reference">map of number (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference">(custom) (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 /xusers/secure/users/activestatus Content-Type: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_XUserREST_deleteUsersByUserName_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/xusers/secure/users/delete <a href="../xusers/secure/users/delete" 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 "Content-Type: application/json" 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 "Content-Type: application/xml" 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> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> DELETE /xusers/secure/users/delete Content-Type: application/json <code class="prettyprint language-js"> { "vXStrings" : [ { "value" : "...", "myClassType" : 12345 }, { "value" : "...", "myClassType" : 12345 } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_XUserREST_modifyUserVisibility_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/xusers/secure/users/visibility <a href="../xusers/secure/users/visibility" 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 "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> <td><span class="datatype-reference">map of number (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference">(custom) (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 /xusers/secure/users/visibility Content-Type: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_XUserREST_secureGetXUser_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/secure/users/{id} <a href="../xusers/secure/users/{id}" 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">id</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 "Accept: application/json" 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_VXUser.html">VXUser</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 "Accept: application/xml" 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_VXUser.html">VXUser</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 /xusers/secure/users/{id} 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"> { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_secureUpdateXUser_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/xusers/secure/users/{id} <a href="../xusers/secure/users/{id}" 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 "Content-Type: application/json" 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_VXUser.html">VXUser</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_VXUser.html">VXUser</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 "Accept: application/json" 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_VXUser.html">VXUser</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 "Accept: application/xml" 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_VXUser.html">VXUser</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 /xusers/secure/users/{id} Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </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"> { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_deleteSingleUserByUserName_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/xusers/secure/users/{userName} <a href="../xusers/secure/users/{userName}" 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">userName</span></td> <td>path</td> <td><span class="parameter-description"></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> DELETE /xusers/secure/users/{userName} Content-Type: */* <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_XUserREST_updateDeletedGroups_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/ugsync/groups/visibility <a href="../xusers/ugsync/groups/visibility" 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 "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> <td><span class="datatype-reference">array of string (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference">list of string (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 "Accept: application/json" 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">number (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 "Accept: application/xml" 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">int (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 /xusers/ugsync/groups/visibility Content-Type: application/json 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-txt"> ... </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_updateDeletedUsers_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/ugsync/users/visibility <a href="../xusers/ugsync/users/visibility" 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 "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> <td><span class="datatype-reference">array of string (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference">list of string (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 "Accept: application/json" 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">number (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 "Accept: application/xml" 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">int (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 /xusers/ugsync/users/visibility Content-Type: application/json 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-txt"> ... </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_deleteXUserByUserName_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/xusers/users/userName/{userName} <a href="../xusers/users/userName/{userName}" 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">userName</span></td> <td>path</td> <td><span class="parameter-description"></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> DELETE /xusers/users/userName/{userName} Content-Type: */* <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getXUserByUserName_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/users/userName/{userName} <a href="../xusers/users/userName/{userName}" 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">userName</span></td> <td>path</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 "Accept: application/json" 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_VXUser.html">VXUser</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 "Accept: application/xml" 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_VXUser.html">VXUser</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 /xusers/users/userName/{userName} 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"> { "name" : "...", "firstName" : "...", "lastName" : "...", "emailAddress" : "...", "password" : "...", "description" : "...", "credStoreId" : 12345, "groupIdList" : [ 12345, 12345 ], "myClassType" : 12345, "status" : 12345, "isVisible" : 12345, "userSource" : 12345, "userRoleList" : [ "...", "..." ], "groupNameList" : [ "...", "..." ], "otherAttributes" : "...", "syncSource" : "...", "id" : 12345, "createDate" : 12345, "updateDate" : 12345, "owner" : "...", "updatedBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_deleteXGroupAndXUser_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/xusers/group/{groupName}/user/{userName} <a href="../xusers/group/{groupName}/user/{userName}" 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">groupName</span></td> <td>path</td> <td><span class="parameter-description"></span></td> </tr> <tr> <td><span class="parameter-name">userName</span></td> <td>path</td> <td><span class="parameter-description"></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> DELETE /xusers/group/{groupName}/user/{userName} Content-Type: */* <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_XUserREST_deleteSingleGroupByGroupId_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/xusers/secure/groups/id/{groupId} <a href="../xusers/secure/groups/id/{groupId}" 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">groupId</span></td> <td>path</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-constraints">long</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> DELETE /xusers/secure/groups/id/{groupId} Content-Type: */* <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getUserRolesByExternalID_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/secure/users/external/{userId} <a href="../xusers/secure/users/external/{userId}" 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-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 "Accept: application/json" 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_VXStringList.html">VXStringList</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 "Accept: application/xml" 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_VXStringList.html">VXStringList</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 /xusers/secure/users/external/{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"> { "vXStrings" : [ { "value" : "...", "myClassType" : 12345 }, { "value" : "...", "myClassType" : 12345 } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_deleteSingleUserByUserId_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/xusers/secure/users/id/{userId} <a href="../xusers/secure/users/id/{userId}" 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> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> DELETE /xusers/secure/users/id/{userId} Content-Type: */* <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_XUserREST_setUserRolesByExternalID_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/xusers/secure/users/roles/{userId} <a href="../xusers/secure/users/roles/{userId}" 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 "Content-Type: application/json" 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 "Content-Type: application/xml" 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 "Accept: application/json" 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_VXStringList.html">VXStringList</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 "Accept: application/xml" 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_VXStringList.html">VXStringList</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 /xusers/secure/users/roles/{userId} Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "vXStrings" : [ { "value" : "...", "myClassType" : 12345 }, { "value" : "...", "myClassType" : 12345 } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </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"> { "vXStrings" : [ { "value" : "...", "myClassType" : 12345 }, { "value" : "...", "myClassType" : 12345 } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_getUserRolesByName_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/secure/users/roles/userName/{userName} <a href="../xusers/secure/users/roles/userName/{userName}" 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">userName</span></td> <td>path</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 "Accept: application/json" 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_VXStringList.html">VXStringList</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 "Accept: application/xml" 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_VXStringList.html">VXStringList</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 /xusers/secure/users/roles/userName/{userName} 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"> { "vXStrings" : [ { "value" : "...", "myClassType" : 12345 }, { "value" : "...", "myClassType" : 12345 } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_XUserREST_setUserRolesByName_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/xusers/secure/users/roles/userName/{userName} <a href="../xusers/secure/users/roles/userName/{userName}" 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">userName</span></td> <td>path</td> <td><span class="parameter-description"></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 "Content-Type: application/json" 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 "Content-Type: application/xml" 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 "Accept: application/json" 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_VXStringList.html">VXStringList</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 "Accept: application/xml" 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_VXStringList.html">VXStringList</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 /xusers/secure/users/roles/userName/{userName} Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "vXStrings" : [ { "value" : "...", "myClassType" : 12345 }, { "value" : "...", "myClassType" : 12345 } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </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"> { "vXStrings" : [ { "value" : "...", "myClassType" : 12345 }, { "value" : "...", "myClassType" : 12345 } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </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>  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>  <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>

apidocs/resource_XUserREST.html (8,786 lines of code) (raw):