Skip to content
XOS Developers

credentials

Credentials module · 4 operations

List credential rows

GET/credentials

An issued credential. Credentials cannot be self-issued. Returns a cursor page of credential rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create a credential

POST/credentials

An issued credential. Credentials cannot be self-issued. Creates a credential. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Get a credential

GET/credentials/{id}

An issued credential. Credentials cannot be self-issued. Returns one credential with its `ETag`. A credential the caller may not see returns 404.

Revoke a credential

POST/credentials/{id}/revoke

Revokes the credential; scans after revocation are refused. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.