Users reference
Users endpoint authentication, parameters, request and response contracts.
Last updated:
Paths, methods, parameters and available schemas are generated from the OpenAPI document in the repository.
Note: These endpoints form the browser application contract and do not provide the same versioning assurance as v1. Use the versioned API for external integrations.
PATCH /api/users/{uid}
Update user
Authentication: User session (cookie). Scope: Relevant organisation/project membership and operation permission; writes also check the current role, module and licence permissions.
Parameters
| Name | Location | Type | Required |
|---|---|---|---|
uid | path | integer | Yes |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
username | string | null | No | |
full_name | string | null | No | |
email | string | null | No | |
role | string | null | No | |
active | boolean | null | No | |
password | string | null | No |
Responses
HTTP 200
application/json
This OpenAPI document does not define a body schema. See the relevant developer guide for details.
HTTP 422
application/json
| Field | Type | Required | Description |
|---|---|---|---|
detail | ValidationError[] | No |
For error meanings and client actions, see the error code glossary.
POST /api/users/{uid}/logout
End user sessions
Authentication: User session (cookie). Scope: Relevant organisation/project membership and operation permission; writes also check the current role, module and licence permissions.
Parameters
| Name | Location | Type | Required |
|---|---|---|---|
uid | path | integer | Yes |
Responses
HTTP 200
application/json
This OpenAPI document does not define a body schema. See the relevant developer guide for details.
HTTP 422
application/json
| Field | Type | Required | Description |
|---|---|---|---|
detail | ValidationError[] | No |
For error meanings and client actions, see the error code glossary.
