UserREST Resource

GET /users

Implements the traditional search functionalities for UserProfile

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

Example

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

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

                
{
  "vXPortalUsers" : [ {
    "loginId" : "...",
    "password" : "...",
    "status" : 12345,
    "emailAddress" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "publicScreenName" : "...",
    "userSource" : 12345,
    "notes" : "...",
    "userRoleList" : [ "...", "..." ],
    "myClassType" : 12345,
    "groupIdList" : [ 12345, 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" : "..."
    } ],
    "groupPermissions" : [ {
      "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" : "..."
    } ],
    "otherAttributes" : "...",
    "configProperties" : {
      "property1" : "...",
      "property2" : "..."
    },
    "syncSource" : "...",
    "id" : 12345,
    "createDate" : 12345,
    "updateDate" : 12345,
    "owner" : "...",
    "updatedBy" : "..."
  }, {
    "loginId" : "...",
    "password" : "...",
    "status" : 12345,
    "emailAddress" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "publicScreenName" : "...",
    "userSource" : 12345,
    "notes" : "...",
    "userRoleList" : [ "...", "..." ],
    "myClassType" : 12345,
    "groupIdList" : [ 12345, 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" : "..."
    } ],
    "groupPermissions" : [ {
      "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" : "..."
    } ],
    "otherAttributes" : "...",
    "configProperties" : {
      "property1" : "...",
      "property2" : "..."
    },
    "syncSource" : "...",
    "id" : 12345,
    "createDate" : 12345,
    "updateDate" : 12345,
    "owner" : "...",
    "updatedBy" : "..."
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}

POST /users

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

Example

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

                
{
  "loginId" : "...",
  "password" : "...",
  "status" : 12345,
  "emailAddress" : "...",
  "firstName" : "...",
  "lastName" : "...",
  "publicScreenName" : "...",
  "userSource" : 12345,
  "notes" : "...",
  "userRoleList" : [ "...", "..." ],
  "myClassType" : 12345,
  "groupIdList" : [ 12345, 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" : "..."
  } ],
  "groupPermissions" : [ {
    "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" : "..."
  } ],
  "otherAttributes" : "...",
  "configProperties" : {
    "property1" : "...",
    "property2" : "..."
  },
  "syncSource" : "...",
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "loginId" : "...",
  "password" : "...",
  "status" : 12345,
  "emailAddress" : "...",
  "firstName" : "...",
  "lastName" : "...",
  "publicScreenName" : "...",
  "userSource" : 12345,
  "notes" : "...",
  "userRoleList" : [ "...", "..." ],
  "myClassType" : 12345,
  "groupIdList" : [ 12345, 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" : "..."
  } ],
  "groupPermissions" : [ {
    "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" : "..."
  } ],
  "otherAttributes" : "...",
  "configProperties" : {
    "property1" : "...",
    "property2" : "..."
  },
  "syncSource" : "...",
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

PUT /users

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

Example

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

                
{
  "loginId" : "...",
  "password" : "...",
  "status" : 12345,
  "emailAddress" : "...",
  "firstName" : "...",
  "lastName" : "...",
  "publicScreenName" : "...",
  "userSource" : 12345,
  "notes" : "...",
  "userRoleList" : [ "...", "..." ],
  "myClassType" : 12345,
  "groupIdList" : [ 12345, 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" : "..."
  } ],
  "groupPermissions" : [ {
    "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" : "..."
  } ],
  "otherAttributes" : "...",
  "configProperties" : {
    "property1" : "...",
    "property2" : "..."
  },
  "syncSource" : "...",
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "loginId" : "...",
  "password" : "...",
  "status" : 12345,
  "emailAddress" : "...",
  "firstName" : "...",
  "lastName" : "...",
  "publicScreenName" : "...",
  "userSource" : 12345,
  "notes" : "...",
  "userRoleList" : [ "...", "..." ],
  "myClassType" : 12345,
  "groupIdList" : [ 12345, 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" : "..."
  } ],
  "groupPermissions" : [ {
    "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" : "..."
  } ],
  "otherAttributes" : "...",
  "configProperties" : {
    "property1" : "...",
    "property2" : "..."
  },
  "syncSource" : "...",
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

POST /users/default

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

Example

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

                
{
  "loginId" : "...",
  "password" : "...",
  "status" : 12345,
  "emailAddress" : "...",
  "firstName" : "...",
  "lastName" : "...",
  "publicScreenName" : "...",
  "userSource" : 12345,
  "notes" : "...",
  "userRoleList" : [ "...", "..." ],
  "myClassType" : 12345,
  "groupIdList" : [ 12345, 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" : "..."
  } ],
  "groupPermissions" : [ {
    "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" : "..."
  } ],
  "otherAttributes" : "...",
  "configProperties" : {
    "property1" : "...",
    "property2" : "..."
  },
  "syncSource" : "...",
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "loginId" : "...",
  "password" : "...",
  "status" : 12345,
  "emailAddress" : "...",
  "firstName" : "...",
  "lastName" : "...",
  "publicScreenName" : "...",
  "userSource" : 12345,
  "notes" : "...",
  "userRoleList" : [ "...", "..." ],
  "myClassType" : 12345,
  "groupIdList" : [ 12345, 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" : "..."
  } ],
  "groupPermissions" : [ {
    "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" : "..."
  } ],
  "otherAttributes" : "...",
  "configProperties" : {
    "property1" : "...",
    "property2" : "..."
  },
  "syncSource" : "...",
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

GET /users/profile

This method returns the VUserProfile for the current session

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

Example

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

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

                
{
  "loginId" : "...",
  "password" : "...",
  "status" : 12345,
  "emailAddress" : "...",
  "firstName" : "...",
  "lastName" : "...",
  "publicScreenName" : "...",
  "userSource" : 12345,
  "notes" : "...",
  "userRoleList" : [ "...", "..." ],
  "myClassType" : 12345,
  "groupIdList" : [ 12345, 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" : "..."
  } ],
  "groupPermissions" : [ {
    "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" : "..."
  } ],
  "otherAttributes" : "...",
  "configProperties" : {
    "property1" : "...",
    "property2" : "..."
  },
  "syncSource" : "...",
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

GET /users/{userId}

Return the VUserProfile for the given userId

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

Example

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

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

                
{
  "loginId" : "...",
  "password" : "...",
  "status" : 12345,
  "emailAddress" : "...",
  "firstName" : "...",
  "lastName" : "...",
  "publicScreenName" : "...",
  "userSource" : 12345,
  "notes" : "...",
  "userRoleList" : [ "...", "..." ],
  "myClassType" : 12345,
  "groupIdList" : [ 12345, 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" : "..."
  } ],
  "groupPermissions" : [ {
    "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" : "..."
  } ],
  "otherAttributes" : "...",
  "configProperties" : {
    "property1" : "...",
    "property2" : "..."
  },
  "syncSource" : "...",
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

POST /users/{userId}/deactivate

Deactivate the user

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

Example

Request
POST /users/{userId}/deactivate
Content-Type: application/json
Accept: application/json

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

                
{
  "loginId" : "...",
  "password" : "...",
  "status" : 12345,
  "emailAddress" : "...",
  "firstName" : "...",
  "lastName" : "...",
  "publicScreenName" : "...",
  "userSource" : 12345,
  "notes" : "...",
  "userRoleList" : [ "...", "..." ],
  "myClassType" : 12345,
  "groupIdList" : [ 12345, 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" : "..."
  } ],
  "groupPermissions" : [ {
    "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" : "..."
  } ],
  "otherAttributes" : "...",
  "configProperties" : {
    "property1" : "...",
    "property2" : "..."
  },
  "syncSource" : "...",
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

POST /users/{userId}/emailchange

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

Example

Request
POST /users/{userId}/emailchange
Content-Type: application/json
Accept: application/json

                
{
  "id" : 12345,
  "loginId" : "...",
  "emailAddress" : "...",
  "resetCode" : "...",
  "oldPassword" : "...",
  "updPassword" : "...",
  "myClassType" : 12345
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "loginId" : "...",
  "password" : "...",
  "status" : 12345,
  "emailAddress" : "...",
  "firstName" : "...",
  "lastName" : "...",
  "publicScreenName" : "...",
  "userSource" : 12345,
  "notes" : "...",
  "userRoleList" : [ "...", "..." ],
  "myClassType" : 12345,
  "groupIdList" : [ 12345, 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" : "..."
  } ],
  "groupPermissions" : [ {
    "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" : "..."
  } ],
  "otherAttributes" : "...",
  "configProperties" : {
    "property1" : "...",
    "property2" : "..."
  },
  "syncSource" : "...",
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

POST /users/{userId}/passwordchange

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

Example

Request
POST /users/{userId}/passwordchange
Content-Type: application/json
Accept: application/json

                
{
  "id" : 12345,
  "loginId" : "...",
  "emailAddress" : "...",
  "resetCode" : "...",
  "oldPassword" : "...",
  "updPassword" : "...",
  "myClassType" : 12345
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "statusCode" : 12345,
  "msgDesc" : "...",
  "messageList" : [ {
    "name" : "...",
    "rbKey" : "...",
    "message" : "...",
    "objectId" : 12345,
    "fieldName" : "...",
    "myClassType" : 12345
  }, {
    "name" : "...",
    "rbKey" : "...",
    "message" : "...",
    "objectId" : 12345,
    "fieldName" : "...",
    "myClassType" : 12345
  } ],
  "myClassType" : 12345
}

PUT /users/{userId}/roles

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 VXResponse (JSON)

Example

Request
PUT /users/{userId}/roles
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

                
{
  "statusCode" : 12345,
  "msgDesc" : "...",
  "messageList" : [ {
    "name" : "...",
    "rbKey" : "...",
    "message" : "...",
    "objectId" : 12345,
    "fieldName" : "...",
    "myClassType" : 12345
  }, {
    "name" : "...",
    "rbKey" : "...",
    "message" : "...",
    "objectId" : 12345,
    "fieldName" : "...",
    "myClassType" : 12345
  } ],
  "myClassType" : 12345
}