Admin paths

The admin API, one route at a time: the request each endpoint takes and the response it answers. They sit behind the admin API reference, which lists every endpoint and field; these pages show a real run of each.

Each block is a command that was run and the output it printed. Ids, ETag values and timestamps belong to one run and refer to each other within a page.

How they were captured is in How the transcripts are captured and checked.

Pages

• Admin API: the shape of it
• Getting the token
• GET /admin/tenants
• POST /admin/tenants
• GET /admin/tenants/{tenant} and PATCH…
• DELETE /admin/tenants/{tenant}
• GET /export
• POST /admin/tenant-imports
• GET /settings and PATCH /settings
• GET /clients, POST /clients and GET /clients/{id}
• PATCH /clients/{id}
• DELETE /clients/{id}
• POST /clients/{id}/secret
• GET /clients/:id/logout-deliveries
• DELETE /clients/:id/grants
• GET /clients/:id/evaluate
• GET /clients/:id/installation
• GET /registration-tokens, POST /registration-tokens and…
• GET /whoami
• GET /subjects
• POST /subjects
• GET /subjects/username-policy
• GET /subjects/:id
• PATCH /subjects/:id
• GET /subjects/:id/profile and PATCH /subjects/:id/profile
• DELETE /subjects/:id
• POST /subjects/bulk
• GET /subjects/:id/credentials
• DELETE /subjects/:id/credentials/:credentialId
• DELETE /subjects/:id/recovery-codes
• GET /subjects/:id/consents and DELETE…
• GET /subjects/:id/lockout
• DELETE /subjects/:id/lockout
• DELETE /lockouts
• POST /subjects/:id/password-reset and POST…
• POST /subjects/:id/actions-email
• POST /subjects/:id/password
• GET /subjects/:id/required-actions and PUT…
• GET /subjects/:id/roles and PUT /subjects/:id/roles
• GET /subjects/:id/effective-roles
• GET /subjects/:id/admin-capabilities
• GET /subjects/:id/groups and PUT /subjects/:id/groups
• GET /subjects/:id/sessions and DELETE…
• DELETE /subjects/:id/sessions
• GET /subjects/:id/grants and DELETE…
• GET /sessions, GET /sessions/count and GET…
• DELETE /sessions
• GET /roles, POST /roles, GET /roles/:id, PATCH /roles/:id…
• POST /roles/:id/composites
• GET /roles/:id/composites and DELETE…
• PUT /roles/:id/default
• GET /groups, POST /groups, GET /groups/:id, PATCH…
• GET /groups/:id/roles and PUT /groups/:id/roles
• PUT /groups/:id/default
• GET /scopes, POST /scopes, GET /scopes/:id, PATCH…
• GET /scopes/:id/roles and PUT /scopes/:id/roles
• GET /scopes/:id/clients
• PUT /scopes/:id/clients/:clientId
• DELETE /scopes/:id/clients/:clientId
• GET /scopes/:id/impact, GET /scopes/builtins and POST…
• GET /scopes/:id/mappers and PUT /scopes/:id/mappers
• GET /keys, POST /keys, POST /keys/:id/promote and POST…
• DELETE /keys/:id
• GET /flow/executions and PUT /flow/executions
• GET /smtp, PUT /smtp, DELETE /smtp and POST /smtp/test
• GET /mail
• GET /audit
• GET /audit/count and GET /audit/export
• GET /admin/tenants/count, GET /subjects/count, GET…
• GET /admin/openapi.json
• Admin API: what to do next