Skip to main content

Admin API: Registration tokens

Operations on registration tokens 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.

GET /admin/tenants/{tenant}/registration-tokens​

Requires the "manage-clients" capability.

Path parameters​

NameTypeRequiredDetails
tenantstringyesThe tenant being administered, addressed by name.

Query parameters​

NameTypeRequiredDetails
cursorstringnoThe next value of the previous page, to continue after it.
limitintegernoHow many items to return. A value over 200 is treated as 200; the default is 50. Constraints: at least 1.

Responses​

200 OK​

Body: application/json

FieldTypeRequiredDetails
itemsarray of objectyesThe entries of this answer.
items[]objectyes
items[].idstringyesThe token’s identifier, for revoking it. The token itself is never shown again.
items[].remaining_usesintegeryesHow many more registrations the token allows.
items[].created_atstringyesWhen the token was minted.
items[].expires_atstringyesWhen the token stops working.
nextstringnoAn opaque cursor for the next page; absent on the last page.

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.

POST /admin/tenants/{tenant}/registration-tokens​

Requires the "manage-clients" capability.

Answers token exactly once. Nothing else this API serves ever repeats it: not a later GET, not an audit detail.

Path parameters​

NameTypeRequiredDetails
tenantstringyesThe tenant being administered, addressed by name.

Request body​

Body: application/json

FieldTypeRequiredDetails
usesintegeryesHow many client registrations the token allows before it is spent. Constraints: at least 1, at most 2147483647.
ttl_secondsintegeryesHow long the token stays valid, from 60 seconds to a year. Constraints: at least 60, at most 31536000.

Responses​

201 Created​

Body: application/json

FieldTypeRequiredDetails
idstringyesThe token’s identifier, for revoking it.
tokenstringyesThe initial access token. Shown only in this response; give it to the registering client as a bearer token.
remaining_usesintegeryesHow many registrations it allows.
expires_atstringyesWhen it stops working.

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.

DELETE /admin/tenants/{tenant}/registration-tokens/{id}​

Requires the "manage-clients" capability.

Path parameters​

NameTypeRequiredDetails
tenantstringyesThe tenant being administered, addressed by name.
idstringyesA row id. Constraints: a UUID.

Responses​

204 OK​

Body: application/json

FieldTypeRequiredDetails
(body)anyyes

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: 14 of 14 fields described (100%).