Users
Users and roles.
All paths are relative to the base path /api/v1 (same origin as the UI). Authentication, roles, pagination and the error format are described in the overview; the types are on the page Data types.
| Operation | Request | Permission |
|---|---|---|
| List users | GET /users | users:manage (admin) |
| Change role (sets roleSource=manual) or disable a user | PATCH /users/{id} | users:manage (admin) |
List users
GET /api/v1/users
Operation listUsers. Permission users:manage (lowest role: admin).
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
| 200 | Users | application/json | UserList |
| 403 | Missing permission (code forbidden) or CSRF failure (code csrf_failed) | application/problem+json | Problem |
Change role (sets roleSource=manual) or disable a user
PATCH /api/v1/users/{id}
Operation updateUser. Permission users:manage (lowest role: admin).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Format uuid. |
X-CSRF-Token | header | string | no | Required for cookie-authenticated mutating requests (value of cookie myriarch_csrf). |
Request body
Content type application/json, required. Type: UpdateUserRequest.
{
"role": "viewer",
"disabled": false
}
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
| 200 | Updated user | application/json | User |
| 404 | Not found (code not_found) | application/problem+json | Problem |
| 412 | Invalid state transition or precondition (code precondition_failed) | application/problem+json | Problem |
| 422 | Validation failed (code validation_failed, details in issues) | application/problem+json | Problem |