User Management
The User Management endpoints list, create, get, and update users, and return the signed-in user.
For the corresponding user interface, refer to the System Setup > User section.
Endpoints
GET /user_management/userList/
Returns the user accounts on the appliance with their roles and state.
Example Request
curl -X GET "https://<your domain>/api/user_management/userList/" \
-H "Authorization: Bearer <token>"
Responses
| Status Code | Description |
|---|
| 200 | The requested records. |
POST /user_management/userList/
Creates a user account.
Request Body (application/json)
| Field | Type | Required | Description |
|---|
| last_login | string (date-time) | No | Last login |
| is_superuser | boolean | No | Designates that this user has all permissions without explicitly assigning them. |
| username | string | Yes | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. |
| first_name | string | No | First name |
| last_name | string | No | Last name |
| email | string (email) | No | Email address |
| is_staff | boolean | No | Designates whether the user can log into this admin site. |
| is_active | boolean | No | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
| date_joined | string (date-time) | No | Date joined |
| user_permissions | array of integer | No | Specific permissions for this user. |
Example Request
curl -X POST "https://<your domain>/api/user_management/userList/" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"username":"string"}'
Responses
| Status Code | Description |
|---|
| 201 | The operation completed. |
GET /user_management/userList/{id}/
Returns one user account by identifier.
Request Parameters
| Name | Located In | Type | Required | Description |
|---|
| id | Path | integer | Yes | A unique integer value identifying this user. |
Example Request
curl -X GET "https://<your domain>/api/user_management/userList/<id>/" \
-H "Authorization: Bearer <token>"
Responses
| Status Code | Description |
|---|
| 200 | The requested records. |
PUT /user_management/userList/{id}/
Replaces a user account. Where the account holds team memberships or approvals, a replacement user may be named to inherit them.
Request Parameters
| Name | Located In | Type | Required | Description |
|---|
| id | Path | integer | Yes | A unique integer value identifying this user. |
Request Body (application/json)
| Field | Type | Required | Description |
|---|
| last_login | string (date-time) | No | Last login |
| is_superuser | boolean | No | Designates that this user has all permissions without explicitly assigning them. |
| username | string | Yes | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. |
| first_name | string | No | First name |
| last_name | string | No | Last name |
| email | string (email) | No | Email address |
| is_staff | boolean | No | Designates whether the user can log into this admin site. |
| is_active | boolean | No | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
| date_joined | string (date-time) | No | Date joined |
| user_permissions | array of integer | No | Specific permissions for this user. |
Example Request
curl -X PUT "https://<your domain>/api/user_management/userList/<id>/" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"username":"string"}'
Responses
| Status Code | Description |
|---|
| 200 | The record after the update. |
PATCH /user_management/userList/{id}/
Updates selected fields of a user account. Send only the fields to change.
Request Parameters
| Name | Located In | Type | Required | Description |
|---|
| id | Path | integer | Yes | A unique integer value identifying this user. |
Request Body (application/json)
| Field | Type | Required | Description |
|---|
| last_login | string (date-time) | No | Last login |
| is_superuser | boolean | No | Designates that this user has all permissions without explicitly assigning them. |
| username | string | Yes | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. |
| first_name | string | No | First name |
| last_name | string | No | Last name |
| email | string (email) | No | Email address |
| is_staff | boolean | No | Designates whether the user can log into this admin site. |
| is_active | boolean | No | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
| date_joined | string (date-time) | No | Date joined |
| user_permissions | array of integer | No | Specific permissions for this user. |
Example Request
curl -X PATCH "https://<your domain>/api/user_management/userList/<id>/" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"username":"string"}'
Responses
| Status Code | Description |
|---|
| 200 | The record after the update. |
GET /user_management/userProfile/
Returns the profile of the account the request is authenticated as.
Example Request
curl -X GET "https://<your domain>/api/user_management/userProfile/" \
-H "Authorization: Bearer <token>"
Responses
| Status Code | Description |
|---|
| 200 | The requested records. |
