UserApi

getAllUsers

Get all users.


Endpoint	/app/rest/users
Produces	`application/xml` `application/json`
Parameters	`locator: string` `fields: string`
Response	`Users`

addUser

Create a new user.


Endpoint	/app/rest/users
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`body: User` `fields: string`
Response	`User`

deleteUser

Delete user matching the locator.


Endpoint	/app/rest/users/{userLocator}
Parameters	`userLocator: string<UserLocator>`

getUser

Get user matching the locator.


Endpoint	/app/rest/users/{userLocator}
Produces	`application/xml` `application/json`
Parameters	`userLocator: string<UserLocator>` `fields: string`
Response	`User`

replaceUser

Update user matching the locator.


Endpoint	/app/rest/users/{userLocator}
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`userLocator: string<UserLocator>` `body: User` `fields: string`
Response	`User`

removeUserRememberMe

Remove the RememberMe data of the matching user.


Endpoint	/app/rest/users/{userLocator}/debug/rememberMe
Produces	`text/plain`
Parameters	`userLocator: string<UserLocator>`

getAllUserGroups

Get all groups of the matching user.


Endpoint	/app/rest/users/{userLocator}/groups
Produces	`application/xml` `application/json`
Parameters	`userLocator: string<UserLocator>` `fields: string`
Response	`Groups`

setUserGroups

Update groups of the matching user.


Endpoint	/app/rest/users/{userLocator}/groups
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`userLocator: string<UserLocator>` `body: Groups` `fields: string`
Response	`Groups`

removeUserFromGroup

Remove the matching user from the specific group.


Endpoint	/app/rest/users/{userLocator}/groups/{groupLocator}
Parameters	`userLocator: string<UserLocator>` `groupLocator: string` `fields: string`

getUserGroup

Get a user group of the matching user.


Endpoint	/app/rest/users/{userLocator}/groups/{groupLocator}
Produces	`application/xml` `application/json`
Parameters	`userLocator: string<UserLocator>` `groupLocator: string` `fields: string`
Response	`Group`

getUserPermissions

Get all permissions effective for the matching user.


Endpoint	/app/rest/users/{userLocator}/permissions
Produces	`application/xml` `application/json`
Parameters	`userLocator: string<UserLocator>` `locator: string` `fields: string`
Response	`PermissionAssignments`

getUserProperties

Get all properties of the matching user.


Endpoint	/app/rest/users/{userLocator}/properties
Produces	`application/xml` `application/json`
Parameters	`userLocator: string<UserLocator>` `fields: string`
Response	`Properties`

removeUserProperty

Remove a property of the matching user.


Endpoint	/app/rest/users/{userLocator}/properties/{name}
Parameters	`userLocator: string<UserLocator>` `name: string`

getUserProperty

Get a property of the matching user.


Endpoint	/app/rest/users/{userLocator}/properties/{name}
Produces	`text/plain`
Parameters	`userLocator: string<UserLocator>` `name: string`
Response	`string`

setUserProperty

Update a property of the matching user.


Endpoint	/app/rest/users/{userLocator}/properties/{name}
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`userLocator: string<UserLocator>` `name: string` `body: string`
Response	`string`

getAllUserRoles

Get all user roles of the matching user.


Endpoint	/app/rest/users/{userLocator}/roles
Produces	`application/xml` `application/json`
Parameters	`userLocator: string<UserLocator>`
Response	`Roles`

addRoleToUser

Add a role to the matching user.


Endpoint	/app/rest/users/{userLocator}/roles
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`userLocator: string<UserLocator>` `body: Role`
Response	`Role`

setUserRoles

Update user roles of the matching user.


Endpoint	/app/rest/users/{userLocator}/roles
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`userLocator: string<UserLocator>` `body: Roles`
Response	`Roles`

removeUserRoleAtScope

Remove a role with the specific scope from the matching user.


Endpoint	/app/rest/users/{userLocator}/roles/{roleId}/{scope}
Parameters	`userLocator: string<UserLocator>` `roleId: string` `scope: string`

getUserRolesAtScope

Get a user role with the specific scope from the matching user.


Endpoint	/app/rest/users/{userLocator}/roles/{roleId}/{scope}
Produces	`application/xml` `application/json`
Parameters	`userLocator: string<UserLocator>` `roleId: string` `scope: string`
Response	`Role`

addRoleToUserAtScope

Add a role with the specific scope to the matching user.


Endpoint	/app/rest/users/{userLocator}/roles/{roleId}/{scope}
Produces	`application/xml` `application/json`
Parameters	`userLocator: string<UserLocator>` `roleId: string` `scope: string`
Response	`Role`

getUserTokens

Get all authentication tokens of the matching user.


Endpoint	/app/rest/users/{userLocator}/tokens
Produces	`application/xml` `application/json`
Parameters	`userLocator: string<UserLocator>` `fields: string`
Response	`Tokens`

addUserToken

Create a new authentication token for the matching user.


Endpoint	/app/rest/users/{userLocator}/tokens
Produces	`application/xml` `application/json`
Parameters	`userLocator: string` `body: Token` `fields: string`
Response	`Token`

deleteUserToken

Remove an authentication token from the matching user.


Endpoint	/app/rest/users/{userLocator}/tokens/{name}
Parameters	`userLocator: string<UserLocator>` `name: string`

deleteUserField

Remove a property of the matching user.


Endpoint	/app/rest/users/{userLocator}/{field}
Parameters	`userLocator: string<UserLocator>` `field: string`

getUserField

Get a field of the matching user.


Endpoint	/app/rest/users/{userLocator}/{field}
Produces	`text/plain`
Parameters	`userLocator: string<UserLocator>` `field: string`
Response	`string`

setUserField

Update a field of the matching user.


Endpoint	/app/rest/users/{userLocator}/{field}
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`userLocator: string<UserLocator>` `field: string` `body: string`
Response	`string`

Last modified: 30 March 2022