UserApi
getAllUsers
Get all users.
Endpoint | /app/rest/users
|
Produces |
|
Parameters |
|
Response |
addUser
Create a new user.
deleteUser
Delete user matching the locator.
Endpoint | /app/rest/users/{userLocator}
|
Parameters |
|
getUser
Get user matching the locator.
Endpoint | /app/rest/users/{userLocator}
|
Produces |
|
Parameters |
|
Response |
replaceUser
Update user matching the locator.
Endpoint | /app/rest/users/{userLocator}
|
Consumes |
|
Produces |
|
Parameters |
|
Response |
removeUserRememberMe
Remove the RememberMe data of the matching user.
Endpoint | /app/rest/users/{userLocator}/debug/rememberMe
|
Produces |
|
Parameters |
|
getAllUserGroups
Get all groups of the matching user.
Endpoint | /app/rest/users/{userLocator}/groups
|
Produces |
|
Parameters |
|
Response |
setUserGroups
Update groups of the matching user.
Endpoint | /app/rest/users/{userLocator}/groups
|
Consumes |
|
Produces |
|
Parameters |
|
Response |
removeUserFromGroup
Remove the matching user from the specific group.
Endpoint | /app/rest/users/{userLocator}/groups/{groupLocator}
|
Parameters |
|
getUserGroup
Get a user group of the matching user.
Endpoint | /app/rest/users/{userLocator}/groups/{groupLocator}
|
Produces |
|
Parameters |
|
Response |
getUserPermissions
Get all permissions effective for the matching user.
Endpoint | /app/rest/users/{userLocator}/permissions
|
Produces |
|
Parameters |
|
Response |
getUserProperties
Get all properties of the matching user.
Endpoint | /app/rest/users/{userLocator}/properties
|
Produces |
|
Parameters |
|
Response |
removeUserProperty
Remove a property of the matching user.
Endpoint | /app/rest/users/{userLocator}/properties/{name}
|
Parameters |
|
getUserProperty
Get a property of the matching user.
Endpoint | /app/rest/users/{userLocator}/properties/{name}
|
Produces |
|
Parameters |
|
Response |
|
setUserProperty
Update a property of the matching user.
Endpoint | /app/rest/users/{userLocator}/properties/{name}
|
Consumes |
|
Produces |
|
Parameters |
|
Response |
|
getAllUserRoles
Get all user roles of the matching user.
Endpoint | /app/rest/users/{userLocator}/roles
|
Produces |
|
Parameters |
|
Response |
addRoleToUser
Add a role to the matching user.
Endpoint | /app/rest/users/{userLocator}/roles
|
Consumes |
|
Produces |
|
Parameters |
|
Response |
setUserRoles
Update user roles of the matching user.
Endpoint | /app/rest/users/{userLocator}/roles
|
Consumes |
|
Produces |
|
Parameters |
|
Response |
removeUserRoleAtScope
Remove a role with the specific scope from the matching user.
Endpoint | /app/rest/users/{userLocator}/roles/{roleId}/{scope}
|
Parameters |
|
getUserRolesAtScope
Get a user role with the specific scope from the matching user.
Endpoint | /app/rest/users/{userLocator}/roles/{roleId}/{scope}
|
Produces |
|
Parameters |
|
Response |
addRoleToUserAtScope
Add a role with the specific scope to the matching user.
Endpoint | /app/rest/users/{userLocator}/roles/{roleId}/{scope}
|
Produces |
|
Parameters |
|
Response |
getUserTokens
Get all authentication tokens of the matching user.
Endpoint | /app/rest/users/{userLocator}/tokens
|
Produces |
|
Parameters |
|
Response |
addUserToken
Create a new authentication token for the matching user.
deleteUserToken
Remove an authentication token from the matching user.
Endpoint | /app/rest/users/{userLocator}/tokens/{name}
|
Parameters |
|
deleteUserField
Remove a property of the matching user.
Endpoint | /app/rest/users/{userLocator}/{field}
|
Parameters |
|
getUserField
Get a field of the matching user.
Endpoint | /app/rest/users/{userLocator}/{field}
|
Produces |
|
Parameters |
|
Response |
|
setUserField
Update a field of the matching user.
Endpoint | /app/rest/users/{userLocator}/{field}
|
Consumes |
|
Produces |
|
Parameters |
|
Response |
|