Users
Endpoint: https://server:port/api/users
Supported actions: GET, POST, DELETE, PATCH
Examples
GET https://server:port/api/users
GET https://server:port/api/users/c6d6ef81-2dfe-411a-8bee-e16137b1b135
POST https://server:port/api/users
DELETE https://server:port/api/users/c6d6ef81-2dfe-411a-8bee-e16137b1b135
PATCH https://server:port/api/users/c6d6ef81-2dfe-411a-8bee-e16137b1b135
Required permissions for each action
GET: accessSettings
POST: manageUsers
DELETE: manageUsers
PATCH: manageUsers
POST Request content to add a new user to an existing group:
{
"name": "username",
"password": "secret_password",
"addToDefaultGroup": false,
"groups": [ "767b3597-16f6-41e9-886d-ebbc007581bc" ]
}
POST Response:
{
"groups": [
"767b3597-16f6-41e9-886d-ebbc007581bc"
],
"id": "2af37cdd-8e7f-432b-9f68-2b8ab2f82759",
"name": "username"
}
POST Request content to add a new user to the default group:
{
"name": "username",
"password": "secret_password",
"addToDefaultGroup": true,
"groups": null
}
POST Response:
{
"groups": [
"d2c13210-3e6b-48f6-8e94-316109bcf7b5"
],
"id": "a3efbf25-0f3d-4e1f-97dd-44b1149210bd",
"name": "username"
}
Comments
0 comments
Please sign in to leave a comment.