XUserREST Resource

GET /xusers/auditmaps

Implements the traditional search functionalities for XAuditMaps

Response Body
media type data type description
application/json VXAuditMapList (JSON)

Example

Request
GET /xusers/auditmaps
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "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" : "..."
}

POST /xusers/auditmaps

Request Body
media type data type
application/json VXAuditMap (JSON)
Response Body
media type data type description
application/json VXAuditMap (JSON)

Example

Request
POST /xusers/auditmaps
Content-Type: application/json
Accept: application/json

                
{
  "resourceId" : 12345,
  "groupId" : 12345,
  "userId" : 12345,
  "auditType" : 12345,
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "resourceId" : 12345,
  "groupId" : 12345,
  "userId" : 12345,
  "auditType" : 12345,
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

PUT /xusers/auditmaps

Request Body
media type data type
application/json VXAuditMap (JSON)
Response Body
media type data type description
application/json VXAuditMap (JSON)

Example

Request
PUT /xusers/auditmaps
Content-Type: application/json
Accept: application/json

                
{
  "resourceId" : 12345,
  "groupId" : 12345,
  "userId" : 12345,
  "auditType" : 12345,
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "resourceId" : 12345,
  "groupId" : 12345,
  "userId" : 12345,
  "auditType" : 12345,
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

GET /xusers/authSessions

Response Body
media type data type description
application/json VXAuthSessionList (JSON)

Example

Request
GET /xusers/authSessions
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "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" : "..."
}

GET /xusers/groupgroups

Implements the traditional search functionalities for XGroupGroups

Response Body
media type data type description
application/json VXGroupGroupList (JSON)

Example

Request
GET /xusers/groupgroups
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "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" : "..."
}

POST /xusers/groupgroups

Request Body
media type data type
application/json VXGroupGroup (JSON)
Response Body
media type data type description
application/json VXGroupGroup (JSON)

Example

Request
POST /xusers/groupgroups
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "parentGroupId" : 12345,
  "groupId" : 12345,
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "name" : "...",
  "parentGroupId" : 12345,
  "groupId" : 12345,
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

PUT /xusers/groupgroups

Request Body
media type data type
application/json VXGroupGroup (JSON)
Response Body
media type data type description
application/json VXGroupGroup (JSON)

Example

Request
PUT /xusers/groupgroups
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "parentGroupId" : 12345,
  "groupId" : 12345,
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "name" : "...",
  "parentGroupId" : 12345,
  "groupId" : 12345,
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

GET /xusers/groups

Implements the traditional search functionalities for XGroups

Response Body
media type data type description
application/json VXGroupList (JSON)

Example

Request
GET /xusers/groups
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "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" : "..."
}

POST /xusers/groups

Request Body
media type data type
application/json VXGroup (JSON)
Response Body
media type data type description
application/json VXGroup (JSON)

Example

Request
POST /xusers/groups
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "description" : "...",
  "groupType" : 12345,
  "credStoreId" : 12345,
  "isVisible" : 12345,
  "myClassType" : 12345,
  "groupSource" : 12345,
  "otherAttributes" : "...",
  "syncSource" : "...",
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "name" : "...",
  "description" : "...",
  "groupType" : 12345,
  "credStoreId" : 12345,
  "isVisible" : 12345,
  "myClassType" : 12345,
  "groupSource" : 12345,
  "otherAttributes" : "...",
  "syncSource" : "...",
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

PUT /xusers/groups

Request Body
media type data type
application/json VXGroup (JSON)
Response Body
media type data type description
application/json VXGroup (JSON)

Example

Request
PUT /xusers/groups
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "description" : "...",
  "groupType" : 12345,
  "credStoreId" : 12345,
  "isVisible" : 12345,
  "myClassType" : 12345,
  "groupSource" : 12345,
  "otherAttributes" : "...",
  "syncSource" : "...",
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "name" : "...",
  "description" : "...",
  "groupType" : 12345,
  "credStoreId" : 12345,
  "isVisible" : 12345,
  "myClassType" : 12345,
  "groupSource" : 12345,
  "otherAttributes" : "...",
  "syncSource" : "...",
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

GET /xusers/groupusers

Implements the traditional search functionalities for XGroupUsers

Response Body
media type data type description
application/json VXGroupUserList (JSON)

Example

Request
GET /xusers/groupusers
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "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" : "..."
}

POST /xusers/groupusers

Request Body
media type data type
application/json VXGroupUser (JSON)
Response Body
media type data type description
application/json VXGroupUser (JSON)

Example

Request
POST /xusers/groupusers
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "parentGroupId" : 12345,
  "userId" : 12345,
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "name" : "...",
  "parentGroupId" : 12345,
  "userId" : 12345,
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

PUT /xusers/groupusers

Request Body
media type data type
application/json VXGroupUser (JSON)
Response Body
media type data type description
application/json VXGroupUser (JSON)

Example

Request
PUT /xusers/groupusers
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "parentGroupId" : 12345,
  "userId" : 12345,
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "name" : "...",
  "parentGroupId" : 12345,
  "userId" : 12345,
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

GET /xusers/permission

Response Body
media type data type description
application/json VXModuleDefList (JSON)

Example

Request
GET /xusers/permission
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "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" : "..."
}

POST /xusers/permission

Request Body
media type data type
application/json VXModuleDef (JSON)
Response Body
media type data type description
application/json VXModuleDef (JSON)

Example

Request
POST /xusers/permission
Content-Type: application/json
Accept: application/json

                
{
  "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
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "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
}

GET /xusers/permissionlist

Response Body
media type data type description
application/json VXModulePermissionList (JSON)

Example

Request
GET /xusers/permissionlist
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "vXModulePermissionList" : [ {
    "module" : "...",
    "userNameList" : [ "...", "..." ],
    "groupNameList" : [ "...", "..." ],
    "id" : 12345,
    "createDate" : 12345,
    "updateDate" : 12345,
    "owner" : "...",
    "updatedBy" : "...",
    "myClassType" : 12345
  }, {
    "module" : "...",
    "userNameList" : [ "...", "..." ],
    "groupNameList" : [ "...", "..." ],
    "id" : 12345,
    "createDate" : 12345,
    "updateDate" : 12345,
    "owner" : "...",
    "updatedBy" : "...",
    "myClassType" : 12345
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}

GET /xusers/permmaps

Implements the traditional search functionalities for XPermMaps

Response Body
media type data type description
application/json VXPermMapList (JSON)

Example

Request
GET /xusers/permmaps
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "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" : "..."
}

POST /xusers/permmaps

Request Body
media type data type
application/json VXPermMap (JSON)
Response Body
media type data type description
application/json VXPermMap (JSON)

Example

Request
POST /xusers/permmaps
Content-Type: application/json
Accept: application/json

                
{
  "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" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "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" : "..."
}

PUT /xusers/permmaps

Request Body
media type data type
application/json VXPermMap (JSON)
Response Body
media type data type description
application/json VXPermMap (JSON)

Example

Request
PUT /xusers/permmaps
Content-Type: application/json
Accept: application/json

                
{
  "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" : "..."
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "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" : "..."
}

GET /xusers/users

Implements the traditional search functionalities for XUsers

Response Body
media type data type description
application/json VXUserList (JSON)

Example

Request
GET /xusers/users
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "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" : "..."
}

POST /xusers/users

Request Body
media type data type
application/json VXUser (JSON)
Response Body
media type data type description
application/json VXUser (JSON)

Example

Request
POST /xusers/users
Content-Type: application/json
Accept: application/json

                
{
  "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" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "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" : "..."
}

PUT /xusers/users

Request Body
media type data type
application/json VXUser (JSON)
Response Body
media type data type description
application/json VXUser (JSON)

Example

Request
PUT /xusers/users
Content-Type: application/json
Accept: application/json

                
{
  "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" : "..."
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "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" : "..."
}

GET /xusers/auditmaps/count

Response Body
media type data type description
application/json VXLong (JSON)

Example

Request
GET /xusers/auditmaps/count
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "value" : 12345,
  "myClassType" : 12345
}

DELETE /xusers/auditmaps/{id}

Request Parameters
name type description constraints
id path long

Example

Request
DELETE /xusers/auditmaps/{id}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /xusers/auditmaps/{id}

Request Parameters
name type description constraints
id path long
Response Body
media type data type description
application/json VXAuditMap (JSON)

Example

Request
GET /xusers/auditmaps/{id}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "resourceId" : 12345,
  "groupId" : 12345,
  "userId" : 12345,
  "auditType" : 12345,
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

GET /xusers/authSessions/info

Response Body
media type data type description
application/json VXAuthSession (JSON)

Example

Request
GET /xusers/authSessions/info
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "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" : "..."
}

GET /xusers/download/{serviceName}

Request Parameters
name type description default constraints
serviceName path    
clusterName query  
lastActivationTime query 0 long
lastKnownUserStoreVersion query -1 long
pluginCapabilities query  
pluginId query    
Response Body
media type data type description
application/json RangerUserStore (JSON)

Example

Request
GET /xusers/download/{serviceName}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "groupAttrMapping" : {
    "property1" : { },
    "property2" : { }
  },
  "userStoreUpdateTime" : 12345,
  "userAttrMapping" : {
    "property1" : { },
    "property2" : { }
  },
  "userStoreVersion" : 12345,
  "userGroupMapping" : {
    "property1" : [ "...", "..." ],
    "property2" : [ "...", "..." ]
  },
  "groupCloudIdMapping" : {
    "property1" : "...",
    "property2" : "..."
  },
  "userCloudIdMapping" : {
    "property1" : "...",
    "property2" : "..."
  }
}

GET /xusers/groupgroups/count

Response Body
media type data type description
application/json VXLong (JSON)

Example

Request
GET /xusers/groupgroups/count
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "value" : 12345,
  "myClassType" : 12345
}

DELETE /xusers/groupgroups/{id}

Request Parameters
name type description constraints
id path long

Example

Request
DELETE /xusers/groupgroups/{id}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /xusers/groupgroups/{id}

Request Parameters
name type description constraints
id path long
Response Body
media type data type description
application/json VXGroupGroup (JSON)

Example

Request
GET /xusers/groupgroups/{id}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "name" : "...",
  "parentGroupId" : 12345,
  "groupId" : 12345,
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

GET /xusers/groups/count

Response Body
media type data type description
application/json VXLong (JSON)

Example

Request
GET /xusers/groups/count
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "value" : 12345,
  "myClassType" : 12345
}

POST /xusers/groups/groupinfo

Request Body
media type data type
application/json VXGroupUserInfo (JSON)
Response Body
media type data type description
application/json VXGroupUserInfo (JSON)

Example

Request
POST /xusers/groups/groupinfo
Content-Type: application/json
Accept: application/json

                
{
  "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
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "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
}

DELETE /xusers/groups/{id}

Request Parameters
name type description constraints
id path long

Example

Request
DELETE /xusers/groups/{id}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /xusers/groups/{id}

Request Parameters
name type description constraints
id path long
Response Body
media type data type description
application/json VXGroup (JSON)

Example

Request
GET /xusers/groups/{id}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "name" : "...",
  "description" : "...",
  "groupType" : 12345,
  "credStoreId" : 12345,
  "isVisible" : 12345,
  "myClassType" : 12345,
  "groupSource" : 12345,
  "otherAttributes" : "...",
  "syncSource" : "...",
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

GET /xusers/groupusers/count

Response Body
media type data type description
application/json VXLong (JSON)

Example

Request
GET /xusers/groupusers/count
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "value" : 12345,
  "myClassType" : 12345
}

DELETE /xusers/groupusers/{id}

Request Parameters
name type description constraints
id path long

Example

Request
DELETE /xusers/groupusers/{id}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /xusers/groupusers/{id}

Request Parameters
name type description constraints
id path long
Response Body
media type data type description
application/json VXGroupUser (JSON)

Example

Request
GET /xusers/groupusers/{id}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "name" : "...",
  "parentGroupId" : 12345,
  "userId" : 12345,
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

GET /xusers/lookup/groups

Response Body
media type data type description
application/json VXStringList (JSON)

Example

Request
GET /xusers/lookup/groups
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "vXStrings" : [ {
    "value" : "...",
    "myClassType" : 12345
  }, {
    "value" : "...",
    "myClassType" : 12345
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}

GET /xusers/lookup/users

Response Body
media type data type description
application/json VXStringList (JSON)

Example

Request
GET /xusers/lookup/users
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "vXStrings" : [ {
    "value" : "...",
    "myClassType" : 12345
  }, {
    "value" : "...",
    "myClassType" : 12345
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}

GET /xusers/permission/count

Response Body
media type data type description
application/json VXLong (JSON)

Example

Request
GET /xusers/permission/count
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "value" : 12345,
  "myClassType" : 12345
}

GET /xusers/permission/group

Response Body
media type data type description
application/json VXGroupPermissionList (JSON)

Example

Request
GET /xusers/permission/group
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "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" : "..."
}

POST /xusers/permission/group

Request Body
media type data type
application/json VXGroupPermission (JSON)
Response Body
media type data type description
application/json VXGroupPermission (JSON)

Example

Request
POST /xusers/permission/group
Content-Type: application/json
Accept: application/json

                
{
  "id" : 12345,
  "groupId" : 12345,
  "groupName" : "...",
  "moduleId" : 12345,
  "isAllowed" : 12345,
  "moduleName" : "...",
  "myClassType" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "id" : 12345,
  "groupId" : 12345,
  "groupName" : "...",
  "moduleId" : 12345,
  "isAllowed" : 12345,
  "moduleName" : "...",
  "myClassType" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

GET /xusers/permission/user

Response Body
media type data type description
application/json VXUserPermissionList (JSON)

Example

Request
GET /xusers/permission/user
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "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" : "..."
}

POST /xusers/permission/user

Request Body
media type data type
application/json VXUserPermission (JSON)
Response Body
media type data type description
application/json VXUserPermission (JSON)

Example

Request
POST /xusers/permission/user
Content-Type: application/json
Accept: application/json

                
{
  "id" : 12345,
  "userId" : 12345,
  "moduleId" : 12345,
  "isAllowed" : 12345,
  "userName" : "...",
  "moduleName" : "...",
  "loginId" : "...",
  "myClassType" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "id" : 12345,
  "userId" : 12345,
  "moduleId" : 12345,
  "isAllowed" : 12345,
  "userName" : "...",
  "moduleName" : "...",
  "loginId" : "...",
  "myClassType" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

DELETE /xusers/permission/{id}

Request Parameters
name type description constraints
id path long

Example

Request
DELETE /xusers/permission/{id}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /xusers/permission/{id}

Request Parameters
name type description constraints
id path long
Response Body
media type data type description
application/json VXModuleDef (JSON)

Example

Request
GET /xusers/permission/{id}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "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
}

PUT /xusers/permission/{id}

Request Body
media type data type
application/json VXModuleDef (JSON)
Response Body
media type data type description
application/json VXModuleDef (JSON)

Example

Request
PUT /xusers/permission/{id}
Content-Type: application/json
Accept: application/json

                
{
  "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
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "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
}

GET /xusers/permmaps/count

Response Body
media type data type description
application/json VXLong (JSON)

Example

Request
GET /xusers/permmaps/count
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "value" : 12345,
  "myClassType" : 12345
}

DELETE /xusers/permmaps/{id}

Request Parameters
name type description constraints
id path long

Example

Request
DELETE /xusers/permmaps/{id}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /xusers/permmaps/{id}

Request Parameters
name type description constraints
id path long
Response Body
media type data type description
application/json VXPermMap (JSON)

Example

Request
GET /xusers/permmaps/{id}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "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" : "..."
}

POST /xusers/secure/groups

Request Body
media type data type
application/json VXGroup (JSON)
Response Body
media type data type description
application/json VXGroup (JSON)

Example

Request
POST /xusers/secure/groups
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "description" : "...",
  "groupType" : 12345,
  "credStoreId" : 12345,
  "isVisible" : 12345,
  "myClassType" : 12345,
  "groupSource" : 12345,
  "otherAttributes" : "...",
  "syncSource" : "...",
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "name" : "...",
  "description" : "...",
  "groupType" : 12345,
  "credStoreId" : 12345,
  "isVisible" : 12345,
  "myClassType" : 12345,
  "groupSource" : 12345,
  "otherAttributes" : "...",
  "syncSource" : "...",
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

POST /xusers/secure/users

Request Body
media type data type
application/json VXUser (JSON)
Response Body
media type data type description
application/json VXUser (JSON)

Example

Request
POST /xusers/secure/users
Content-Type: application/json
Accept: application/json

                
{
  "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" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "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" : "..."
}

POST /xusers/ugsync/auditinfo

Request Body
media type data type
application/json VXUgsyncAuditInfo (JSON)
Response Body
media type data type description
application/json VXUgsyncAuditInfo (JSON)

Example

Request
POST /xusers/ugsync/auditinfo
Content-Type: application/json
Accept: application/json

                
{
  "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
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "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
}

POST /xusers/ugsync/groups

Request Body
media type data type
application/json VXGroupList (JSON)
Response Body
media type data type description
application/json number (JSON)

Example

Request
POST /xusers/ugsync/groups
Content-Type: application/json
Accept: application/json

                
{
  "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" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

GET /xusers/ugsync/groupusers

Response Body
media type data type description
application/json map of array of string (JSON)

Example

Request
GET /xusers/ugsync/groupusers
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

POST /xusers/ugsync/groupusers

Request Body
media type data type
application/json array of GroupUserInfo (JSON)
Response Body
media type data type description
application/json number (JSON)

Example

Request
POST /xusers/ugsync/groupusers
Content-Type: application/json
Accept: application/json

                
[ {
  "delUsers" : [ "...", "..." ],
  "groupName" : "...",
  "addUsers" : [ "...", "..." ]
} ]
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /xusers/ugsync/users

Request Body
media type data type
application/json VXUserList (JSON)
Response Body
media type data type description
application/json string (JSON)

Example

Request
POST /xusers/ugsync/users
Content-Type: application/json
Accept: application/json

                
{
  "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" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

GET /xusers/users/count

Response Body
media type data type description
application/json VXLong (JSON)

Example

Request
GET /xusers/users/count
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "value" : 12345,
  "myClassType" : 12345
}

POST /xusers/users/external

Request Body
media type data type
application/json VXUser (JSON)
Response Body
media type data type description
application/json VXUser (JSON)

Example

Request
POST /xusers/users/external
Content-Type: application/json
Accept: application/json

                
{
  "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" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "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" : "..."
}

POST /xusers/users/roleassignments

Request Body
media type data type
application/json UsersGroupRoleAssignments (JSON)
application/xml usersGroupRoleAssignments (XML)
Response Body
media type data type description
application/json array of string (JSON)

Example

Request
POST /xusers/users/roleassignments
Content-Type: application/json
Accept: application/json

                
{
  "reset" : true,
  "users" : [ "...", "..." ],
  "userRoleAssignments" : {
    "property1" : "...",
    "property2" : "..."
  },
  "whiteListGroupRoleAssignments" : {
    "property1" : "...",
    "property2" : "..."
  },
  "groupRoleAssignments" : {
    "property1" : "...",
    "property2" : "..."
  },
  "whiteListUserRoleAssignments" : {
    "property1" : "...",
    "property2" : "..."
  }
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /xusers/users/userinfo

Request Body
media type data type
application/json VXUserGroupInfo (JSON)
Response Body
media type data type description
application/json VXUserGroupInfo (JSON)

Example

Request
POST /xusers/users/userinfo
Content-Type: application/json
Accept: application/json

                
{
  "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
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "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
}

DELETE /xusers/users/{id}

Request Parameters
name type description constraints
id path long

Example

Request
DELETE /xusers/users/{id}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /xusers/users/{id}

Request Parameters
name type description constraints
id path long
Response Body
media type data type description
application/json VXUser (JSON)

Example

Request
GET /xusers/users/{id}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "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" : "..."
}

GET /xusers/{groupId}/users

Request Parameters
name type description constraints
groupId path long
Response Body
media type data type description
application/json VXUserList (JSON)

Example

Request
GET /xusers/{groupId}/users
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "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" : "..."
}

GET /xusers/{userId}/groups

Request Parameters
name type description constraints
userId path long
Response Body
media type data type description
application/json VXGroupList (JSON)

Example

Request
GET /xusers/{userId}/groups
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "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" : "..."
}

DELETE /xusers/groups/groupName/{groupName}

Request Parameters
name type description
groupName path

Example

Request
DELETE /xusers/groups/groupName/{groupName}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /xusers/groups/groupName/{groupName}

Request Parameters
name type description
groupName path
Response Body
media type data type description
application/json VXGroup (JSON)

Example

Request
GET /xusers/groups/groupName/{groupName}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "name" : "...",
  "description" : "...",
  "groupType" : 12345,
  "credStoreId" : 12345,
  "isVisible" : 12345,
  "myClassType" : 12345,
  "groupSource" : 12345,
  "otherAttributes" : "...",
  "syncSource" : "...",
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

GET /xusers/groupusers/groupName/{groupName}

Implements the traditional search functionalities for XGroupUsers by Group name

Request Parameters
name type description
groupName path
Response Body
media type data type description
application/json VXGroupUserInfo (JSON)

Example

Request
GET /xusers/groupusers/groupName/{groupName}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "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
}

GET /xusers/permission/group/count

Response Body
media type data type description
application/json VXLong (JSON)

Example

Request
GET /xusers/permission/group/count
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "value" : 12345,
  "myClassType" : 12345
}

DELETE /xusers/permission/group/{id}

Request Parameters
name type description constraints
id path long

Example

Request
DELETE /xusers/permission/group/{id}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /xusers/permission/group/{id}

Request Parameters
name type description constraints
id path long
Response Body
media type data type description
application/json VXGroupPermission (JSON)

Example

Request
GET /xusers/permission/group/{id}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "id" : 12345,
  "groupId" : 12345,
  "groupName" : "...",
  "moduleId" : 12345,
  "isAllowed" : 12345,
  "moduleName" : "...",
  "myClassType" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

PUT /xusers/permission/group/{id}

Request Parameters
name type description constraints
id path long
Request Body
media type data type
application/json VXGroupPermission (JSON)
Response Body
media type data type description
application/json VXGroupPermission (JSON)

Example

Request
PUT /xusers/permission/group/{id}
Content-Type: application/json
Accept: application/json

                
{
  "id" : 12345,
  "groupId" : 12345,
  "groupName" : "...",
  "moduleId" : 12345,
  "isAllowed" : 12345,
  "moduleName" : "...",
  "myClassType" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "id" : 12345,
  "groupId" : 12345,
  "groupName" : "...",
  "moduleId" : 12345,
  "isAllowed" : 12345,
  "moduleName" : "...",
  "myClassType" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

GET /xusers/permission/user/count

Response Body
media type data type description
application/json VXLong (JSON)

Example

Request
GET /xusers/permission/user/count
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "value" : 12345,
  "myClassType" : 12345
}

DELETE /xusers/permission/user/{id}

Request Parameters
name type description constraints
id path long

Example

Request
DELETE /xusers/permission/user/{id}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /xusers/permission/user/{id}

Request Parameters
name type description constraints
id path long
Response Body
media type data type description
application/json VXUserPermission (JSON)

Example

Request
GET /xusers/permission/user/{id}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "id" : 12345,
  "userId" : 12345,
  "moduleId" : 12345,
  "isAllowed" : 12345,
  "userName" : "...",
  "moduleName" : "...",
  "loginId" : "...",
  "myClassType" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

PUT /xusers/permission/user/{id}

Request Body
media type data type
application/json VXUserPermission (JSON)
Response Body
media type data type description
application/json VXUserPermission (JSON)

Example

Request
PUT /xusers/permission/user/{id}
Content-Type: application/json
Accept: application/json

                
{
  "id" : 12345,
  "userId" : 12345,
  "moduleId" : 12345,
  "isAllowed" : 12345,
  "userName" : "...",
  "moduleName" : "...",
  "loginId" : "...",
  "myClassType" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "id" : 12345,
  "userId" : 12345,
  "moduleId" : 12345,
  "isAllowed" : 12345,
  "userName" : "...",
  "moduleName" : "...",
  "loginId" : "...",
  "myClassType" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

GET /xusers/secure/download/{serviceName}

Request Parameters
name type description default constraints
serviceName path    
clusterName query  
lastActivationTime query 0 long
lastKnownUserStoreVersion query -1 long
pluginCapabilities query  
pluginId query    
Response Body
media type data type description
application/json RangerUserStore (JSON)

Example

Request
GET /xusers/secure/download/{serviceName}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "groupAttrMapping" : {
    "property1" : { },
    "property2" : { }
  },
  "userStoreUpdateTime" : 12345,
  "userAttrMapping" : {
    "property1" : { },
    "property2" : { }
  },
  "userStoreVersion" : 12345,
  "userGroupMapping" : {
    "property1" : [ "...", "..." ],
    "property2" : [ "...", "..." ]
  },
  "groupCloudIdMapping" : {
    "property1" : "...",
    "property2" : "..."
  },
  "userCloudIdMapping" : {
    "property1" : "...",
    "property2" : "..."
  }
}

DELETE /xusers/secure/groups/delete

Request Body
media type data type
application/json VXStringList (JSON)
application/xml VXStringList (XML)

Example

Request
DELETE /xusers/secure/groups/delete
Content-Type: application/json

                
{
  "vXStrings" : [ {
    "value" : "...",
    "myClassType" : 12345
  }, {
    "value" : "...",
    "myClassType" : 12345
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}
Response
HTTP/1.1 204 No Content

PUT /xusers/secure/groups/visibility

Request Body
media type data type
application/json map of number (JSON)

Example

Request
PUT /xusers/secure/groups/visibility
Content-Type: application/json

                
...
Response
HTTP/1.1 204 No Content

DELETE /xusers/secure/groups/{groupName}

Request Parameters
name type description
groupName path

Example

Request
DELETE /xusers/secure/groups/{groupName}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /xusers/secure/groups/{id}

Request Parameters
name type description constraints
id path long
Response Body
media type data type description
application/json VXGroup (JSON)

Example

Request
GET /xusers/secure/groups/{id}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "name" : "...",
  "description" : "...",
  "groupType" : 12345,
  "credStoreId" : 12345,
  "isVisible" : 12345,
  "myClassType" : 12345,
  "groupSource" : 12345,
  "otherAttributes" : "...",
  "syncSource" : "...",
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

PUT /xusers/secure/groups/{id}

Request Body
media type data type
application/json VXGroup (JSON)
Response Body
media type data type description
application/json VXGroup (JSON)

Example

Request
PUT /xusers/secure/groups/{id}
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "description" : "...",
  "groupType" : 12345,
  "credStoreId" : 12345,
  "isVisible" : 12345,
  "myClassType" : 12345,
  "groupSource" : 12345,
  "otherAttributes" : "...",
  "syncSource" : "...",
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "name" : "...",
  "description" : "...",
  "groupType" : 12345,
  "credStoreId" : 12345,
  "isVisible" : 12345,
  "myClassType" : 12345,
  "groupSource" : 12345,
  "otherAttributes" : "...",
  "syncSource" : "...",
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

PUT /xusers/secure/users/activestatus

Request Body
media type data type
application/json map of number (JSON)
application/xml (custom) (XML)

Example

Request
PUT /xusers/secure/users/activestatus
Content-Type: application/json

                
...
Response
HTTP/1.1 204 No Content

DELETE /xusers/secure/users/delete

Request Body
media type data type
application/json VXStringList (JSON)
application/xml VXStringList (XML)

Example

Request
DELETE /xusers/secure/users/delete
Content-Type: application/json

                
{
  "vXStrings" : [ {
    "value" : "...",
    "myClassType" : 12345
  }, {
    "value" : "...",
    "myClassType" : 12345
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}
Response
HTTP/1.1 204 No Content

PUT /xusers/secure/users/visibility

Request Body
media type data type
application/json map of number (JSON)

Example

Request
PUT /xusers/secure/users/visibility
Content-Type: application/json

                
...
Response
HTTP/1.1 204 No Content

GET /xusers/secure/users/{id}

Request Parameters
name type description constraints
id path long
Response Body
media type data type description
application/json VXUser (JSON)

Example

Request
GET /xusers/secure/users/{id}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "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" : "..."
}

PUT /xusers/secure/users/{id}

Request Body
media type data type
application/json VXUser (JSON)
Response Body
media type data type description
application/json VXUser (JSON)

Example

Request
PUT /xusers/secure/users/{id}
Content-Type: application/json
Accept: application/json

                
{
  "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" : "..."
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "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" : "..."
}

DELETE /xusers/secure/users/{userName}

Request Parameters
name type description
userName path

Example

Request
DELETE /xusers/secure/users/{userName}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

POST /xusers/ugsync/groups/visibility

Request Body
media type data type
application/json array of string (JSON)
Response Body
media type data type description
application/json number (JSON)

Example

Request
POST /xusers/ugsync/groups/visibility
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /xusers/ugsync/users/visibility

Request Body
media type data type
application/json array of string (JSON)
Response Body
media type data type description
application/json number (JSON)

Example

Request
POST /xusers/ugsync/users/visibility
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

DELETE /xusers/users/userName/{userName}

Request Parameters
name type description
userName path

Example

Request
DELETE /xusers/users/userName/{userName}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /xusers/users/userName/{userName}

Request Parameters
name type description
userName path
Response Body
media type data type description
application/json VXUser (JSON)

Example

Request
GET /xusers/users/userName/{userName}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "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" : "..."
}

DELETE /xusers/group/{groupName}/user/{userName}

Request Parameters
name type description
groupName path
userName path

Example

Request
DELETE /xusers/group/{groupName}/user/{userName}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

DELETE /xusers/secure/groups/id/{groupId}

Request Parameters
name type description constraints
groupId path long

Example

Request
DELETE /xusers/secure/groups/id/{groupId}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /xusers/secure/users/external/{userId}

Request Parameters
name type description constraints
userId path long
Response Body
media type data type description
application/json VXStringList (JSON)

Example

Request
GET /xusers/secure/users/external/{userId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "vXStrings" : [ {
    "value" : "...",
    "myClassType" : 12345
  }, {
    "value" : "...",
    "myClassType" : 12345
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}

DELETE /xusers/secure/users/id/{userId}

Request Parameters
name type description constraints
userId path long

Example

Request
DELETE /xusers/secure/users/id/{userId}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

PUT /xusers/secure/users/roles/{userId}

Request Parameters
name type description constraints
userId path long
Request Body
media type data type
application/json VXStringList (JSON)
Response Body
media type data type description
application/json VXStringList (JSON)

Example

Request
PUT /xusers/secure/users/roles/{userId}
Content-Type: application/json
Accept: application/json

                
{
  "vXStrings" : [ {
    "value" : "...",
    "myClassType" : 12345
  }, {
    "value" : "...",
    "myClassType" : 12345
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "vXStrings" : [ {
    "value" : "...",
    "myClassType" : 12345
  }, {
    "value" : "...",
    "myClassType" : 12345
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}

GET /xusers/secure/users/roles/userName/{userName}

Request Parameters
name type description
userName path
Response Body
media type data type description
application/json VXStringList (JSON)

Example

Request
GET /xusers/secure/users/roles/userName/{userName}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "vXStrings" : [ {
    "value" : "...",
    "myClassType" : 12345
  }, {
    "value" : "...",
    "myClassType" : 12345
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}

PUT /xusers/secure/users/roles/userName/{userName}

Request Parameters
name type description
userName path
Request Body
media type data type
application/json VXStringList (JSON)
Response Body
media type data type description
application/json VXStringList (JSON)

Example

Request
PUT /xusers/secure/users/roles/userName/{userName}
Content-Type: application/json
Accept: application/json

                
{
  "vXStrings" : [ {
    "value" : "...",
    "myClassType" : 12345
  }, {
    "value" : "...",
    "myClassType" : 12345
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "vXStrings" : [ {
    "value" : "...",
    "myClassType" : 12345
  }, {
    "value" : "...",
    "myClassType" : 12345
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}