Admin API: Lockouts
Operations on lockouts in the Odudu admin API, one section each. Every request carries a bearer token; the index says which audience it needs and how a refusal is shaped.
DELETE /admin/tenants/{tenant}/lockouts
Requires the "manage-users" capability.
Clears the run of failed sign-ins of up to 10,000 subjects a call, in id order, as DELETE …/subjects/{id}/lockout clears one; remaining says how many more are left (counted to 10,000), so a caller repeats the call until it is 0 — one call is not every subject. A subject holding an admin capability the caller does not keeps its count and is counted under beyond_ceiling.
Path parameters
| Name | Type | Required | Details |
|---|---|---|---|
tenant | string | yes | The tenant being administered, addressed by name. |
Responses
200 OK
Body: application/json
| Field | Type | Required | Details |
|---|---|---|---|
cleared | integer | yes | How many subjects’ failed sign-ins were cleared. Constraints: at least 0. |
beyond_ceiling | integer | yes | How many hold an admin capability the caller does not, and were left locked. Constraints: at least 0. |
remaining | integer | yes | How many more are left; repeat the call until it is 0. Constraints: at least 0. |
401 RFC 9457 problem details
Body: application/problem+json, an RFC 9457 problem document described under problem details.
403 RFC 9457 problem details
Body: application/problem+json, an RFC 9457 problem document described under problem details.
Documentation coverage: 3 of 3 fields described (100%).