Log out
Revoke the current dashboard session. The 204 response does not guarantee that a client cookie is cleared.
Endpoint
POST
/api/v1/auth/logoutAuthentication
| Operation class | Authentication | Minimum role | API key |
|---|---|---|---|
| dashboard-session-api | No authentication. | none | Not allowed |
Parameters
This operation has no path, query, or header parameters.
Request body
This operation has no request body.
Example
curl --request POST 'https://operade.ai/api/v1/auth/logout'
Responses
| Status | Description | Content |
|---|---|---|
4XX | Handled client error | application/json: ErrorResponse |
204 | Successful Response | No body |
4XX application/json response schema
| Field path | Type | Reference | Format | Nullable | Required | Enum | Description |
|---|---|---|---|---|---|---|---|
$ | object | ErrorResponse | — | No | Yes | — | — |
error | object | ErrorItem | — | No | Yes | — | — |
error.code | string | — | — | No | Yes | — | — |
error.details | object | — | — | No | No | — | — |
error.message | string | — | — | No | Yes | — | — |
Response example
HTTP 204 This response has no body.
Errors
Reviewed common and route-declared errors are summarized here; the list is not exhaustive. Start with the distributed error index to find each code's canonical domain page.
| Status | Code | Description |
|---|---|---|
403 | forbidden | The X-CX-Request header is required when a dashboard session cookie is present. |