Reference
People
The people endpoints of the HTTP API.
GET /users
List everyone who has signed in, newest first.
People are ordered by when they first signed in, newest first, so paging stays stable while people are active; last_seen_at does not affect the order. Service accounts cannot call this endpoint.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
limit |
query | integer |
Between 1 and 500. Default 100. |
cursor |
query | string |
Responses
| Status | Description | Body |
|---|---|---|
200 |
One page of people. | object |
400 |
The request is malformed or fails validation. | Error |
401 |
Authentication is missing or invalid. | Error |
403 |
The caller is not allowed to perform the request; a role that is too low is code forbidden_role. |
Error |
500 |
The server failed to handle the request. | Error |
PATCH /users/{id}
Set or clear the role an Admin chose for a person.
A role value sets the chosen role and null clears it, after which the role is computed again from the server settings, the identity provider’s groups and the default. A role decided by SLASHOBSERVE_ADMIN_EMAILS, by being the first person, or by an identity-provider group is locked and answers 409 with code role_locked. Lowering the last Admin answers 409 with code last_admin. Service accounts cannot call this endpoint.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
id (required) |
path | string (uuid) |
Request body
application/json, required.
A UpdatePersonRequest object.
Responses
| Status | Description | Body |
|---|---|---|
200 |
The person with the resulting role. | Person |
400 |
The request is malformed or fails validation. | Error |
401 |
Authentication is missing or invalid. | Error |
403 |
The caller is not allowed to perform the request; a role that is too low is code forbidden_role. |
Error |
404 |
The resource does not exist. | Error |
409 |
The request conflicts with existing state. | Error |
413 |
The request body exceeds the size limit. | Error |
500 |
The server failed to handle the request. | Error |
DELETE /users/{id}/sessions
Delete every session of a person.
Any signed-in person may sign anyone out, including themselves; the person can sign in again at once. Signing yourself out also expires your session cookie. Service accounts cannot.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
id (required) |
path | string (uuid) |
Responses
| Status | Description | Body |
|---|---|---|
204 |
Every session of the person is deleted. | |
400 |
The request is malformed or fails validation. | Error |
401 |
Authentication is missing or invalid. | Error |
403 |
The caller is not allowed to perform the request; a role that is too low is code forbidden_role. |
Error |
404 |
The resource does not exist. | Error |
500 |
The server failed to handle the request. | Error |
Generated from api/openapi.yaml at bac0fe39. Report a problem.