This is the documentation of iya-sts 1.0.0. The latest is 1.1.0.
What has been issued, and the revocation of the three kinds that can be revoked.
Every answer is checked against the model shown here before it is sent, and no answer carries a member its model does not list. A member shown as any JSON is one whose shape belongs to somebody else, and says whose. .{key} is a key that is data, and [] an element of a list.
A refusal
Unless an operation below says otherwise, any status it does not list answers this:
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | ||
status |
integer | ||
why |
string |
GET /admin-api/tokens
getIssued
Everything issued, grouped into what came back in one reply
One list, newest first, filtered and paged. Claims and facts only — the signed token, the assertion XML and the ticket are never kept, and the jti is all any operation here needs.
AN ENTRY IS ONE ISSUANCE AND NOT ONE CREDENTIAL, since 2026-09-05. OAuth 2.0 and OIDC are the only families here that hand back several credentials at once — an access token, a refresh token and an ID Token out of one code redemption — so those arrive as one entry in sets carrying its members. Every other family issues one credential per act, so a SAML assertion, a Kerberos ticket and an SVID are each a set of one.
issued is the same credentials flattened out of sets, so a caller written against the older per-credential shape reads exactly what it read. What changed under it is the paging: a page is a whole number of replies, so page, pages, matched and shown count SETS while held and matchedCredentials count credentials.
OID4VCI credentials are NOT in this list. They are counted on /admin-api/metrics and listed nowhere, which is a gap rather than a principle and is said here so “everything issued” is read as the four families it says.
Mirrors GET /admin/tokens on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
family |
query | one of token, assertion, ticket, svid |
One protocol family. The reply’s families member lists them with the kinds in each. |
|
kind |
query | one of id_token, access_token, refresh_token, userinfo_response, request_object, gnap_access_token, SAML 2.0, SAML 1.1, Kerberos TGT, Kerberos service ticket, SVID (X.509), SVID (JWT) |
One kind. ANDed with family, so a kind from another family matches nothing — which is what an empty list then means. EVERY FILTER HERE MATCHES A SET WHEN ANY MEMBER MATCHES. Asking for id_token answers with the replies that CONTAIN one — the access token and the refresh token that came back with it are still in members, because they are part of the same reply. A caller that wants only the matching credentials filters issued itself; a filter that hid the neighbours would be the old per-credential list wearing this one’s name. |
|
state |
query | one of valid, expired, revoked, not yet valid, no expiry stated |
One state, matched against any member — so a set holding an expired access token and a valid refresh token is found by both, and its own state reads mixed rather than picking one. |
|
session |
query | string | Only what was issued UNDER one browser sign-on session, matched exactly on the id — the sessionId every row of GET /admin-api/sessions carries, and the join between the two resources. Only a credential issued under a session records one, so an assertion, a Kerberos ticket, a token from either direct grant and anything an RFC 8693 exchange produced are absent by construction rather than missing. That is a fact about the credential and not a gap in the recording. |
|
page |
query | integer | Which page of the match to return. CLAMPED rather than refused: a page past the end returns the last one, and the reply says which page it actually is. | |
per |
query | integer | Rows per page. Defaults to 50 and is capped at 300. On a drill-down it is SHARED by every list in the reply, which each carry a page number of their own. | |
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
200: The matching sets, with the paging that found them and their credentials flattened beside them.
| Member | Type | Required | What it is |
|---|---|---|---|
coverage |
object | ||
coverage.complete |
boolean | ||
coverage.countEstimated |
boolean | ||
coverage.newest |
number, or null | ||
coverage.session |
string, or null | ||
coverage.source |
string | ||
coverage.unread |
boolean | ||
families |
list | ||
families[].family |
string | ||
families[].kinds |
list | ||
families[].kinds[] |
string | ||
families[].label |
string | ||
families[].what |
string | ||
filter |
object | ||
filter.family |
string, or null | ||
filter.kind |
string, or null | ||
filter.session |
string, or null | ||
filter.state |
string, or null | ||
firstRow |
integer | ||
held |
integer | ||
heldByFamily |
map | Credentials held in each family. | |
heldByFamily.{key} |
integer | ||
heldSets |
integer | ||
issued |
list | ||
issued[] |
object | One thing this service issued and still remembers. Claims and facts only: the signed token, the assertion XML and the ticket are deliberately not kept. | |
issued[].client_id |
list, or string, or number, or boolean, or null | ||
issued[].client_id[] |
string, or number, or boolean | ||
issued[].exp |
number | ||
issued[].expiresAtMs |
number, or null | ||
issued[].family |
string | token, assertion, ticket or svid: what the family filter takes. |
|
issued[].grant |
string | ||
issued[].iat |
number | ||
issued[].identifier |
list, or string, or number, or boolean, or null | ||
issued[].identifier[] |
string, or number, or boolean | ||
issued[].issuedAt |
number | ||
issued[].jkt |
string | ||
issued[].jti |
list, or string, or number, or boolean, or null | ||
issued[].jti[] |
string, or number, or boolean | ||
issued[].key |
string | ||
issued[].kind |
string | access_token, id_token, refresh_token, a SAML assertion version, a Kerberos ticket type or an SVID type. | |
issued[].length |
integer | ||
issued[].nbf |
number | ||
issued[].revocable |
boolean | ||
issued[].revoked |
boolean | ||
issued[].revokedAt |
number, or null | ||
issued[].revokedVia |
string | ||
issued[].scope |
list, or string, or number, or boolean, or null | ||
issued[].scope[] |
string, or number, or boolean | ||
issued[].sessionId |
string | ||
issued[].setId |
string | ||
issued[].state |
string | valid, expired, revoked, “not yet valid” or “no expiry stated”. | |
issued[].sub |
list, or string, or number, or boolean, or null | ||
issued[].sub[] |
string, or number, or boolean | ||
issued[].typ |
list, or string, or number, or boolean, or null | ||
issued[].typ[] |
string, or number, or boolean | ||
issued[].username |
list, or string, or number, or boolean, or null | ||
issued[].username[] |
string, or number, or boolean | ||
lastRow |
integer | ||
matched |
integer | ||
matchedCredentials |
integer | ||
page |
integer | ||
pages |
integer | ||
paging |
object | ||
paging.firstRow |
integer | ||
paging.lastRow |
integer | ||
paging.noun |
string | ||
paging.page |
integer | ||
paging.pages |
integer | ||
paging.param |
string | ||
paging.perPage |
integer | ||
paging.total |
integer | ||
perPage |
integer | ||
revocableKinds |
list | ||
revocableKinds[] |
string | ||
revokedCount |
integer | ||
sets |
list | ||
sets[] |
object | One issuance: everything that came back in a single reply. | |
sets[].audience |
string | ||
sets[].client_id |
list, or string, or number, or boolean, or null | ||
sets[].client_id[] |
string, or number, or boolean | ||
sets[].expiresAtMs |
number | ||
sets[].families |
list | ||
sets[].families[] |
string | ||
sets[].family |
string | ||
sets[].grant |
string | ||
sets[].grouped |
boolean | ||
sets[].issuedAt |
number | ||
sets[].kinds |
list | ||
sets[].kinds[] |
string | ||
sets[].lastExpiresAtMs |
number | ||
sets[].members |
list | ||
sets[].members[] |
object | One thing this service issued and still remembers. Claims and facts only: the signed token, the assertion XML and the ticket are deliberately not kept. | |
sets[].members[].client_id |
list, or string, or number, or boolean, or null | ||
sets[].members[].client_id[] |
string, or number, or boolean | ||
sets[].members[].exp |
number | ||
sets[].members[].expiresAtMs |
number, or null | ||
sets[].members[].family |
string | token, assertion, ticket or svid: what the family filter takes. |
|
sets[].members[].grant |
string | ||
sets[].members[].iat |
number | ||
sets[].members[].identifier |
list, or string, or number, or boolean, or null | ||
sets[].members[].identifier[] |
string, or number, or boolean | ||
sets[].members[].issuedAt |
number | ||
sets[].members[].jkt |
string | ||
sets[].members[].jti |
list, or string, or number, or boolean, or null | ||
sets[].members[].jti[] |
string, or number, or boolean | ||
sets[].members[].key |
string | ||
sets[].members[].kind |
string | access_token, id_token, refresh_token, a SAML assertion version, a Kerberos ticket type or an SVID type. | |
sets[].members[].length |
integer | ||
sets[].members[].nbf |
number | ||
sets[].members[].revocable |
boolean | ||
sets[].members[].revoked |
boolean | ||
sets[].members[].revokedAt |
number, or null | ||
sets[].members[].revokedVia |
string | ||
sets[].members[].scope |
list, or string, or number, or boolean, or null | ||
sets[].members[].scope[] |
string, or number, or boolean | ||
sets[].members[].sessionId |
string | ||
sets[].members[].setId |
string | ||
sets[].members[].state |
string | valid, expired, revoked, “not yet valid” or “no expiry stated”. | |
sets[].members[].sub |
list, or string, or number, or boolean, or null | ||
sets[].members[].sub[] |
string, or number, or boolean | ||
sets[].members[].typ |
list, or string, or number, or boolean, or null | ||
sets[].members[].typ[] |
string, or number, or boolean | ||
sets[].members[].username |
list, or string, or number, or boolean, or null | ||
sets[].members[].username[] |
string, or number, or boolean | ||
sets[].revocableCount |
integer | ||
sets[].revokedCount |
integer | ||
sets[].scope |
list, or string, or number, or boolean, or null | ||
sets[].scope[] |
string, or number, or boolean | ||
sets[].sessionAuthenticated |
boolean | ||
sets[].sessionId |
string | ||
sets[].setId |
string | ||
sets[].setKey |
string | ||
sets[].size |
integer | ||
sets[].state |
string | ||
sets[].states |
map | How many members are in each state. | |
sets[].states.{key} |
integer | ||
sets[].sub |
list, or string, or number, or boolean, or null | ||
sets[].sub[] |
string, or number, or boolean | ||
sets[].username |
list, or string, or number, or boolean, or null | ||
sets[].username[] |
string, or number, or boolean | ||
shown |
integer | ||
shownCredentials |
integer |
400: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
GET /admin-api/tokens/credential
getCredentialLineage
One credential and every generation behind it
The credential a protocol identifier names (a jti, an AssertionID) and how it came to exist: one generation per exchange behind it, newest first, down to the issuance the line rests on — each with the act that produced it, the party that holds it (holder) and, at the origin, the grant or flow (originLabel). walls are the lines that stop at a credential this service cannot name; truncated says the walk stopped at maxGenerations. The graph and, as for /delegation/map, looks, the drawing (svg) and its size come with it.
With no id the answer names nothing (counts: null).
With format=svg the answer is the SVG document alone, with no links in it, as image/svg+xml.
Mirrors GET /admin/tokens/credential on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
query | string | The credential’s identifier, as the tokens table shows it. | |
format |
query | one of json, svg |
svg answers the drawing alone, as a document with no links in it. json, the default, answers everything. |
|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
200: The credential, its generations, the graph, every node’s look and the drawing.
As application/json:
| Member | Type | Required | What it is |
|---|---|---|---|
acts |
list | ||
acts[].at |
number | ||
acts[].authorizedBy |
string | ||
acts[].chainKey |
string | ||
acts[].consumed |
list | ||
acts[].consumed[].identifier |
string | ||
acts[].consumed[].kind |
string | ||
acts[].consumed[].note |
string | ||
acts[].initial |
object | ||
acts[].initial.application |
string | ||
acts[].initial.key |
string | ||
acts[].initial.presented |
string | ||
acts[].initial.what |
string | ||
acts[].intermediary |
object | ||
acts[].intermediary.application |
string | ||
acts[].intermediary.key |
string | ||
acts[].intermediary.presented |
string | ||
acts[].intermediary.what |
string | ||
acts[].mode |
string | ||
acts[].note |
string | ||
acts[].origin |
string, or number, or null | ||
acts[].outcome |
string | ||
acts[].policed |
boolean | ||
acts[].produced |
list | ||
acts[].produced[].identifier |
string | ||
acts[].produced[].kind |
string | ||
acts[].produced[].note |
string | ||
acts[].protocol |
string | ||
acts[].reason |
string | ||
acts[].seq |
number | ||
acts[].sessionId |
string | ||
acts[].spec |
string | ||
acts[].target |
object | ||
acts[].target.application |
string | ||
acts[].target.key |
string | ||
acts[].target.presented |
string | ||
acts[].target.what |
string | ||
acts[].type |
string | ||
acts[].typeLabel |
string | ||
counts |
object | ||
counts.acts |
integer | ||
counts.exchanges |
integer | ||
counts.generations |
integer | ||
counts.parties |
integer | ||
credential |
object, or null | One thing this service issued and still remembers. Claims and facts only: the signed token, the assertion XML and the ticket are deliberately not kept. | |
credential.client_id |
list, or string, or number, or boolean, or null | ||
credential.client_id[] |
string, or number, or boolean | ||
credential.exp |
number | ||
credential.expiresAtMs |
number, or null | ||
credential.family |
string | token, assertion, ticket or svid: what the family filter takes. |
|
credential.grant |
string | ||
credential.iat |
number | ||
credential.identifier |
list, or string, or number, or boolean, or null | ||
credential.identifier[] |
string, or number, or boolean | ||
credential.issuedAt |
number | ||
credential.jkt |
string | ||
credential.jti |
list, or string, or number, or boolean, or null | ||
credential.jti[] |
string, or number, or boolean | ||
credential.key |
string | ||
credential.kind |
string | access_token, id_token, refresh_token, a SAML assertion version, a Kerberos ticket type or an SVID type. | |
credential.length |
integer | ||
credential.nbf |
number | ||
credential.revocable |
boolean | ||
credential.revoked |
boolean | ||
credential.revokedAt |
number, or null | ||
credential.revokedVia |
string | ||
credential.scope |
list, or string, or number, or boolean, or null | ||
credential.scope[] |
string, or number, or boolean | ||
credential.sessionId |
string | ||
credential.setId |
string | ||
credential.state |
string | valid, expired, revoked, “not yet valid” or “no expiry stated”. | |
credential.sub |
list, or string, or number, or boolean, or null | ||
credential.sub[] |
string, or number, or boolean | ||
credential.typ |
list, or string, or number, or boolean, or null | ||
credential.typ[] |
string, or number, or boolean | ||
credential.username |
list, or string, or number, or boolean, or null | ||
credential.username[] |
string, or number, or boolean | ||
drawing |
object | ||
drawing.failed |
string, or null | ||
drawing.height |
number | ||
drawing.width |
number | ||
facts |
object | ||
facts.apps |
map | Which values in the answer are applications. | |
facts.apps.{key}.dnLabel |
string | ||
facts.apps.{key}.name |
string | ||
facts.users |
map | Who in the answer has a user page. | |
facts.users.{key} |
boolean | ||
generations |
list | ||
generations[].act |
object | ||
generations[].act.at |
number | ||
generations[].act.authorizedBy |
string | ||
generations[].act.chainKey |
string | ||
generations[].act.consumed |
list | ||
generations[].act.consumed[].identifier |
string | ||
generations[].act.consumed[].kind |
string | ||
generations[].act.consumed[].note |
string | ||
generations[].act.initial |
object | ||
generations[].act.initial.application |
string | ||
generations[].act.initial.key |
string | ||
generations[].act.initial.presented |
string | ||
generations[].act.initial.what |
string | ||
generations[].act.intermediary |
object | ||
generations[].act.intermediary.application |
string | ||
generations[].act.intermediary.key |
string | ||
generations[].act.intermediary.presented |
string | ||
generations[].act.intermediary.what |
string | ||
generations[].act.mode |
string | ||
generations[].act.note |
string | ||
generations[].act.origin |
string, or number, or null | ||
generations[].act.outcome |
string | ||
generations[].act.policed |
boolean | ||
generations[].act.produced |
list | ||
generations[].act.produced[].identifier |
string | ||
generations[].act.produced[].kind |
string | ||
generations[].act.produced[].note |
string | ||
generations[].act.protocol |
string | ||
generations[].act.reason |
string | ||
generations[].act.seq |
number | ||
generations[].act.sessionId |
string | ||
generations[].act.spec |
string | ||
generations[].act.target |
object | ||
generations[].act.target.application |
string | ||
generations[].act.target.key |
string | ||
generations[].act.target.presented |
string | ||
generations[].act.target.what |
string | ||
generations[].act.type |
string | ||
generations[].act.typeLabel |
string | ||
generations[].consumed |
list | ||
generations[].consumed[].identifier |
string | ||
generations[].consumed[].kind |
string | ||
generations[].consumed[].note |
string | ||
generations[].credential |
object, or null | One thing this service issued and still remembers. Claims and facts only: the signed token, the assertion XML and the ticket are deliberately not kept. | |
generations[].credential.client_id |
list, or string, or number, or boolean, or null | ||
generations[].credential.client_id[] |
string, or number, or boolean | ||
generations[].credential.exp |
number | ||
generations[].credential.expiresAtMs |
number, or null | ||
generations[].credential.family |
string | token, assertion, ticket or svid: what the family filter takes. |
|
generations[].credential.grant |
string | ||
generations[].credential.iat |
number | ||
generations[].credential.identifier |
list, or string, or number, or boolean, or null | ||
generations[].credential.identifier[] |
string, or number, or boolean | ||
generations[].credential.issuedAt |
number | ||
generations[].credential.jkt |
string | ||
generations[].credential.jti |
list, or string, or number, or boolean, or null | ||
generations[].credential.jti[] |
string, or number, or boolean | ||
generations[].credential.key |
string | ||
generations[].credential.kind |
string | access_token, id_token, refresh_token, a SAML assertion version, a Kerberos ticket type or an SVID type. | |
generations[].credential.length |
integer | ||
generations[].credential.nbf |
number | ||
generations[].credential.revocable |
boolean | ||
generations[].credential.revoked |
boolean | ||
generations[].credential.revokedAt |
number, or null | ||
generations[].credential.revokedVia |
string | ||
generations[].credential.scope |
list, or string, or number, or boolean, or null | ||
generations[].credential.scope[] |
string, or number, or boolean | ||
generations[].credential.sessionId |
string | ||
generations[].credential.setId |
string | ||
generations[].credential.state |
string | valid, expired, revoked, “not yet valid” or “no expiry stated”. | |
generations[].credential.sub |
list, or string, or number, or boolean, or null | ||
generations[].credential.sub[] |
string, or number, or boolean | ||
generations[].credential.typ |
list, or string, or number, or boolean, or null | ||
generations[].credential.typ[] |
string, or number, or boolean | ||
generations[].credential.username |
list, or string, or number, or boolean, or null | ||
generations[].credential.username[] |
string, or number, or boolean | ||
generations[].generation |
integer | ||
generations[].holder |
string | ||
generations[].identifier |
string | ||
generations[].opaque |
list | ||
generations[].opaque[].identifier |
string | ||
generations[].opaque[].kind |
string | ||
generations[].opaque[].note |
string | ||
generations[].originLabel |
string | ||
generations[].producedByExchange |
boolean | ||
graph |
object | ||
graph.acts |
integer | ||
graph.chains |
integer | ||
graph.edges |
list | ||
graph.edges[].actor |
string | ||
graph.edges[].acts |
integer | ||
graph.edges[].attribute |
string | ||
graph.edges[].audience |
string | ||
graph.edges[].audienceRegistered |
boolean | ||
graph.edges[].authorizedBy |
string | ||
graph.edges[].chainKey |
string | ||
graph.edges[].consumed |
list | ||
graph.edges[].consumed[].count |
integer | ||
graph.edges[].consumed[].identifiers |
list | ||
graph.edges[].consumed[].identifiers[] |
string | ||
graph.edges[].consumed[].kind |
string | ||
graph.edges[].consumed[].moreIdentifiers |
integer | ||
graph.edges[].consumed[].notes |
list | ||
graph.edges[].consumed[].notes[] |
string | ||
graph.edges[].credentials |
integer | ||
graph.edges[].firstAt |
number | ||
graph.edges[].from |
string | ||
graph.edges[].fromRole |
string | ||
graph.edges[].id |
string | ||
graph.edges[].issued |
integer | ||
graph.edges[].lastAt |
number | ||
graph.edges[].mechanism |
string | ||
graph.edges[].mode |
string | ||
graph.edges[].permissions |
list | ||
graph.edges[].permissions[] |
string | ||
graph.edges[].policed |
boolean | ||
graph.edges[].produced |
list | ||
graph.edges[].produced[].count |
integer | ||
graph.edges[].produced[].identifiers |
list | ||
graph.edges[].produced[].identifiers[] |
string | ||
graph.edges[].produced[].kind |
string | ||
graph.edges[].produced[].moreIdentifiers |
integer | ||
graph.edges[].produced[].notes |
list | ||
graph.edges[].produced[].notes[] |
string | ||
graph.edges[].protocol |
string | ||
graph.edges[].protocols |
list | ||
graph.edges[].protocols[] |
string | ||
graph.edges[].reason |
string | ||
graph.edges[].refused |
integer | ||
graph.edges[].relation |
string | ||
graph.edges[].scopes |
list | ||
graph.edges[].scopes[] |
string | ||
graph.edges[].setOn |
string | ||
graph.edges[].skipped |
list | ||
graph.edges[].skipped[] |
string | ||
graph.edges[].spec |
string | ||
graph.edges[].subject |
string | ||
graph.edges[].to |
string | ||
graph.edges[].toRole |
string | ||
graph.edges[].type |
string | ||
graph.edges[].typeLabel |
string | ||
graph.edges[].used |
boolean | ||
graph.issuer |
string | ||
graph.maxTokenRows |
integer | ||
graph.nodes |
list | ||
graph.nodes[].acts |
integer | ||
graph.nodes[].aliases |
list | ||
graph.nodes[].aliases[] |
string | ||
graph.nodes[].application |
string | ||
graph.nodes[].authentications |
integer | ||
graph.nodes[].chiefRole |
string | ||
graph.nodes[].credentials |
integer | ||
graph.nodes[].firstAt |
number | ||
graph.nodes[].flows |
list | ||
graph.nodes[].flows[] |
string | ||
graph.nodes[].id |
string | ||
graph.nodes[].issued |
integer | ||
graph.nodes[].issuer |
string | ||
graph.nodes[].key |
string | ||
graph.nodes[].kind |
string | ||
graph.nodes[].kinds |
list | ||
graph.nodes[].kinds[] |
string | ||
graph.nodes[].lastAt |
number | ||
graph.nodes[].presented |
string | ||
graph.nodes[].protocols |
list | ||
graph.nodes[].protocols[] |
string | ||
graph.nodes[].realm |
object | ||
graph.nodes[].realm.id |
string | ||
graph.nodes[].realm.isDefault |
boolean | ||
graph.nodes[].realm.name |
string | ||
graph.nodes[].refused |
integer | ||
graph.nodes[].roles |
object | ||
graph.nodes[].roles.initial |
integer | ||
graph.nodes[].roles.intermediary |
integer | ||
graph.nodes[].roles.target |
integer | ||
graph.nodes[].selfTarget |
boolean | ||
graph.nodes[].what |
string | ||
graph.realm |
object | ||
graph.realm.id |
string | ||
graph.realm.isDefault |
boolean | ||
graph.realm.name |
string | ||
graph.tokens |
list | ||
graph.tokens[].actor |
string | ||
graph.tokens[].at |
number | ||
graph.tokens[].chainKey |
string | ||
graph.tokens[].identifier |
string | ||
graph.tokens[].kind |
string | ||
graph.tokens[].mode |
string | ||
graph.tokens[].note |
string | ||
graph.tokens[].protocol |
string | ||
graph.tokens[].seq |
number | ||
graph.tokens[].subject |
string | ||
graph.tokens[].target |
string | ||
graph.tokens[].type |
string | ||
graph.tokens[].typeLabel |
string | ||
graph.tokensLeftOff |
integer | ||
held |
boolean, or null | ||
identifier |
string, or null | ||
issuances |
list | ||
issuances[].audience |
object | ||
issuances[].audience.audience |
string | ||
issuances[].audience.identifier |
string | ||
issuances[].audience.registered |
boolean | ||
issuances[].audiences |
list | ||
issuances[].audiences[].audience |
string | ||
issuances[].audiences[].identifier |
string | ||
issuances[].audiences[].registered |
boolean | ||
issuances[].credential |
object | One thing this service issued and still remembers. Claims and facts only: the signed token, the assertion XML and the ticket are deliberately not kept. | |
issuances[].credential.client_id |
list, or string, or number, or boolean, or null | ||
issuances[].credential.client_id[] |
string, or number, or boolean | ||
issuances[].credential.exp |
number | ||
issuances[].credential.expiresAtMs |
number, or null | ||
issuances[].credential.family |
string | token, assertion, ticket or svid: what the family filter takes. |
|
issuances[].credential.grant |
string | ||
issuances[].credential.iat |
number | ||
issuances[].credential.identifier |
list, or string, or number, or boolean, or null | ||
issuances[].credential.identifier[] |
string, or number, or boolean | ||
issuances[].credential.issuedAt |
number | ||
issuances[].credential.jkt |
string | ||
issuances[].credential.jti |
list, or string, or number, or boolean, or null | ||
issuances[].credential.jti[] |
string, or number, or boolean | ||
issuances[].credential.key |
string | ||
issuances[].credential.kind |
string | access_token, id_token, refresh_token, a SAML assertion version, a Kerberos ticket type or an SVID type. | |
issuances[].credential.length |
integer | ||
issuances[].credential.nbf |
number | ||
issuances[].credential.revocable |
boolean | ||
issuances[].credential.revoked |
boolean | ||
issuances[].credential.revokedAt |
number, or null | ||
issuances[].credential.revokedVia |
string | ||
issuances[].credential.scope |
list, or string, or number, or boolean, or null | ||
issuances[].credential.scope[] |
string, or number, or boolean | ||
issuances[].credential.sessionId |
string | ||
issuances[].credential.setId |
string | ||
issuances[].credential.state |
string | valid, expired, revoked, “not yet valid” or “no expiry stated”. | |
issuances[].credential.sub |
list, or string, or number, or boolean, or null | ||
issuances[].credential.sub[] |
string, or number, or boolean | ||
issuances[].credential.typ |
list, or string, or number, or boolean, or null | ||
issuances[].credential.typ[] |
string, or number, or boolean | ||
issuances[].credential.username |
list, or string, or number, or boolean, or null | ||
issuances[].credential.username[] |
string, or number, or boolean | ||
issuances[].flow |
object | ||
issuances[].flow.browser |
boolean | ||
issuances[].flow.flow |
string | ||
issuances[].flow.label |
string | ||
issuances[].flow.match |
string | ||
issuances[].flow.oidc |
string | ||
issuances[].flow.protocol |
string | ||
issuances[].flow.spec |
string | ||
issuances[].flow.unknown |
boolean | ||
issuances[].flow.what |
string | ||
issuances[].holder |
string | ||
issuances[].identifier |
string | ||
issuances[].subject |
string | ||
label |
string | ||
looks |
map | How each node of the graph is drawn. | |
looks.{key}.dashed |
boolean | ||
looks.{key}.href |
string | ||
looks.{key}.identifier |
string | ||
looks.{key}.label |
string | ||
looks.{key}.shape |
string | ||
looks.{key}.sublabel |
string | ||
looks.{key}.title |
string | ||
maxGenerations |
integer | ||
origins |
list | ||
origins[] |
string | ||
subjectKey |
string | ||
svg |
string | ||
truncated |
boolean | ||
walls |
list | ||
walls[].act |
object | ||
walls[].act.at |
number | ||
walls[].act.authorizedBy |
string | ||
walls[].act.chainKey |
string | ||
walls[].act.consumed |
list | ||
walls[].act.consumed[].identifier |
string | ||
walls[].act.consumed[].kind |
string | ||
walls[].act.consumed[].note |
string | ||
walls[].act.initial |
object | ||
walls[].act.initial.application |
string | ||
walls[].act.initial.key |
string | ||
walls[].act.initial.presented |
string | ||
walls[].act.initial.what |
string | ||
walls[].act.intermediary |
object | ||
walls[].act.intermediary.application |
string | ||
walls[].act.intermediary.key |
string | ||
walls[].act.intermediary.presented |
string | ||
walls[].act.intermediary.what |
string | ||
walls[].act.mode |
string | ||
walls[].act.note |
string | ||
walls[].act.origin |
string, or number, or null | ||
walls[].act.outcome |
string | ||
walls[].act.policed |
boolean | ||
walls[].act.produced |
list | ||
walls[].act.produced[].identifier |
string | ||
walls[].act.produced[].kind |
string | ||
walls[].act.produced[].note |
string | ||
walls[].act.protocol |
string | ||
walls[].act.reason |
string | ||
walls[].act.seq |
number | ||
walls[].act.sessionId |
string | ||
walls[].act.spec |
string | ||
walls[].act.target |
object | ||
walls[].act.target.application |
string | ||
walls[].act.target.key |
string | ||
walls[].act.target.presented |
string | ||
walls[].act.target.what |
string | ||
walls[].act.type |
string | ||
walls[].act.typeLabel |
string | ||
walls[].credential |
object | ||
walls[].credential.identifier |
string | ||
walls[].credential.kind |
string | ||
walls[].credential.note |
string | ||
walls[].identifier |
string |
As image/svg+xml.
POST /admin-api/tokens/restore
restoreToken
Un-revoke one token (NON-SPEC)
NON-SPEC, and named as such wherever it appears: no real authorization server can undo a revocation. It is here because otherwise getting back to a working token means restarting the service.
Mirrors POST /admin/tokens on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
jti |
string | Accepted for target. |
|
target |
string | A jti, or a whole JWT. | |
token |
string | Accepted for target. |
200: Restored, or it was not revoked — both are ok.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
jti |
string | ||
message |
string | ||
ok |
boolean | yes |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
jti |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/tokens/restore-artifact
restoreIssuedArtifact
Stop disowning one assertion, ticket or SVID (NON-SPEC)
The opposite of revoke-artifact, and NON-SPEC for the reason every restore here is. It is a smaller act than the others, because what it takes back never reached anybody: the credential was working throughout.
Mirrors POST /admin/tokens on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
artifact |
string | yes | The key off a row of GET /admin-api/tokens. |
key |
string | Accepted for artifact. |
200: Whether it had been disowned.
| Member | Type | Required | What it is |
|---|---|---|---|
artifact |
string | ||
errors |
list | ||
errors[] |
string | ||
kind |
string | ||
message |
string | ||
ok |
boolean | yes | |
revocationReach |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
artifact |
string | ||
errors |
list | ||
errors[] |
string | ||
kind |
string | ||
message |
string | ||
ok |
boolean | yes | |
revocationReach |
string |
POST /admin-api/tokens/restore-set
restoreIssuedSet
Un-revoke every revocable credential in one issuance (NON-SPEC)
The opposite of revoke-set, and NON-SPEC for the reason restore is: no real authorization server can undo a revocation, because a resource server may already have cached the refusal. It is here because otherwise getting back to a working grant means restarting the service.
Mirrors POST /admin/tokens on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
set |
string | yes | The setKey off a row of GET /admin-api/tokens. |
setKey |
string | Accepted for set. |
200: How many were revocable and how many were actually put back.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
kinds |
list | ||
kinds[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
reachedProtocol |
integer | ||
recordOnly |
integer | ||
restored |
integer | ||
revocable |
integer | ||
revoked |
integer | ||
set |
string | ||
setKey |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
kinds |
list | ||
kinds[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
reachedProtocol |
integer | ||
recordOnly |
integer | ||
restored |
integer | ||
revocable |
integer | ||
revoked |
integer | ||
set |
string | ||
setKey |
string |
POST /admin-api/tokens/revoke
revokeToken
Revoke one token
By jti, or by pasting the whole token — what somebody has in their hand when they want a token invalidated is the token, not its identifier. A pasted token’s SIGNATURE IS NOT VERIFIED and that is safe rather than sloppy: the only thing read out of it is the jti, which is then looked up in this service’s own registry, so a forged token yields an identifier this service never issued and revoking one of those invalidates nothing.
This is the SAME revocation set RFC 7009’s /oauth2/revoke writes to, so the token immediately introspects as inactive, is refused by UserInfo with invalid_token, and fails the refresh grant with invalid_grant.
Mirrors POST /admin/tokens on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
jti |
string | Accepted for target. |
|
target |
string | A jti, or a whole JWT. | |
token |
string | Accepted for target. |
200: Revoked, or already revoked — both are ok, and the message says which.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
jti |
string | ||
message |
string | ||
ok |
boolean | yes |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
jti |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/tokens/revoke-all
revokeAllTokens
Revoke every access token, ID Token and refresh token
Everything this service has issued and still remembers. Assertions, tickets and credentials are untouched, for the reason revoke-kind gives.
Mirrors POST /admin/tokens on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body (optional)
An empty object.
200: How many were revoked, in revoked.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
revoked |
integer | ||
user |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
revoked |
integer | ||
user |
string |
POST /admin-api/tokens/revoke-artifact
revokeIssuedArtifact
Disown one assertion, ticket or SVID (RECORD ONLY)
THIS CHANGES NOTHING OUTSIDE THIS SERVICE AND THAT IS NOT A DEFECT. A relying party validates a SAML assertion’s signature and its Conditions and asks nobody; a Kerberos service decrypts a ticket with a key it already holds; an X509-SVID chains to a bundle. None of them will ever consult this service, so the credential goes on working until it expires and the holder is not told.
What it does is record that THIS IDENTITY PROVIDER HAS DISOWNED the credential, which is a different claim and a useful one: it is what a global sign-out can report, what CAEP transmits to a receiver that subscribed, and what SAML Single Logout carries for an assertion issued through a browser profile. A WS-Trust assertion has neither channel and the mark is the whole of what exists for it.
Until 2026-09-05 this was impossible and every surface said so. What changed is the recognition that what this service KNOWS and what a relying party will HONOUR are two claims, and only the second was ever out of reach. Every row of GET /admin-api/tokens carries revocationReach to keep them apart.
Mirrors POST /admin/tokens on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
artifact |
string | yes | The key off a row of GET /admin-api/tokens. This service’s own handle and NOT the protocol’s — a Kerberos ticket carries no identifier anybody can quote, so identifier cannot address every row and this can. |
key |
string | Accepted for artifact. |
200: What was marked, and a sentence saying the holder was not told.
| Member | Type | Required | What it is |
|---|---|---|---|
artifact |
string | ||
errors |
list | ||
errors[] |
string | ||
kind |
string | ||
message |
string | ||
ok |
boolean | yes | |
revocationReach |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
artifact |
string | ||
errors |
list | ||
errors[] |
string | ||
kind |
string | ||
message |
string | ||
ok |
boolean | yes | |
revocationReach |
string |
POST /admin-api/tokens/revoke-kind
revokeTokensByKind
Revoke every token of one kind
Only the three JWT kinds can be revoked. Nothing consults this service about a SAML assertion or a Kerberos ticket — an assertion is valid because its signature verifies and its Conditions hold, a ticket because the service it names can decrypt it — so naming one of those is refused rather than silently doing nothing. GET /admin-api/tokens lists the three under revocableKinds.
Mirrors POST /admin/tokens on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
kind |
one of access_token, id_token, refresh_token, gnap_access_token |
yes |
200: How many were revoked, in revoked.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
revoked |
integer | ||
user |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
revoked |
integer | ||
user |
string |
POST /admin-api/tokens/revoke-set
revokeIssuedSet
Revoke every revocable credential in one issuance
One act instead of one call per credential. It writes NOWHERE NEW: each member goes through the same revocation /oauth2/revoke performs, one at a time, into the same set of revoked jtis — so a token revoked here immediately introspects as inactive, is refused by UserInfo with invalid_token, and fails the refresh grant with invalid_grant.
What it saves is the mistake this whole resource was reshaped to prevent: revoking two credentials of three and believing the grant is dead, when the refresh token left behind mints a new access token on request.
THE MEMBERS ARE RE-READ AT THE MOMENT OF THE CALL and never taken from the caller — the body carries a setKey and nothing else — so a list drawn an hour ago cannot revoke a jti that has since been forgotten to the cap while missing one issued since.
A set holding nothing revocable is REFUSED with 400 rather than answered with “revoked 0”: nothing consults this service about a SAML assertion, a Kerberos ticket or an SVID, so a success would be a claim about the world that is not true. That is the same answer revoke-kind gives for an unrevocable kind.
Mirrors POST /admin/tokens on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
set |
string | yes | The setKey off a row of GET /admin-api/tokens. |
setKey |
string | Accepted for set. |
200: How many were revocable, how many actually moved, and which kinds they were. A member already revoked is counted as revocable and not as moved, so revoked: 0 on an ok reply means the set was already dead.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
kinds |
list | ||
kinds[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
reachedProtocol |
integer | ||
recordOnly |
integer | ||
restored |
integer | ||
revocable |
integer | ||
revoked |
integer | ||
set |
string | ||
setKey |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
kinds |
list | ||
kinds[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
reachedProtocol |
integer | ||
recordOnly |
integer | ||
restored |
integer | ||
revocable |
integer | ||
revoked |
integer | ||
set |
string | ||
setKey |
string |
POST /admin-api/tokens/revoke-subject
revokeTokensBySubject
Revoke everything for one subject or username
Matches sub or username EXACTLY. That is the difference from revoke-user beside it: this is the one to use when you have a string off a token, and that one is for an identity the users list names, which may have been seen under several spellings.
Mirrors POST /admin/tokens on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
subject |
string | yes |
200: How many were revoked, in revoked.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
revoked |
integer | ||
user |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
revoked |
integer | ||
user |
string |
POST /admin-api/tokens/revoke-user
revokeTokensByUser
Revoke everything for one identity, under every spelling
The users list’s key, and every spelling of it — alice, her urn:uuid:<entryUUID> subject and alice@EXAMPLE.COM are one identity here, so revoking “for alice” means all of them. Use revoke-subject when you want an exact string instead.
Mirrors POST /admin/tokens on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
user |
string | yes |
200: How many were revoked, in revoked.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
revoked |
integer | ||
user |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
revoked |
integer | ||
user |
string |
GET /admin-api/tokens/set
getIssuedSet
One issuance, and every credential it carried
What GET /admin-api/tokens groups, opened up. Every entry in that reply’s sets carries the setKey this takes, so a caller walks the list and opens one entry without having to know whether it holds three credentials or one.
It is addressed by setKey and never by the issuer’s setId: a set of one has no issuance id at all, and its key is one:<row handle> so that the key space covers every row of that table. A key nothing holds answers 200 with found: false rather than 404 — a set dropped to the registry’s cap is the ordinary end of a set’s life and not a caller’s mistake, and why says which of the two happened.
Mirrors GET /admin/tokens/set on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
query | string | yes | The setKey off a row of GET /admin-api/tokens. |
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
200: The set and its members, or found: false and the reason.
| Member | Type | Required | What it is |
|---|---|---|---|
found |
boolean | ||
set |
object, or null | One issuance: everything that came back in a single reply. | |
set.audience |
string | ||
set.client_id |
list, or string, or number, or boolean, or null | ||
set.client_id[] |
string, or number, or boolean | ||
set.expiresAtMs |
number | ||
set.families |
list | ||
set.families[] |
string | ||
set.family |
string | ||
set.grant |
string | ||
set.grouped |
boolean | ||
set.issuedAt |
number | ||
set.kinds |
list | ||
set.kinds[] |
string | ||
set.lastExpiresAtMs |
number | ||
set.members |
list | ||
set.members[] |
object | One thing this service issued and still remembers. Claims and facts only: the signed token, the assertion XML and the ticket are deliberately not kept. | |
set.members[].client_id |
list, or string, or number, or boolean, or null | ||
set.members[].client_id[] |
string, or number, or boolean | ||
set.members[].exp |
number | ||
set.members[].expiresAtMs |
number, or null | ||
set.members[].family |
string | token, assertion, ticket or svid: what the family filter takes. |
|
set.members[].grant |
string | ||
set.members[].iat |
number | ||
set.members[].identifier |
list, or string, or number, or boolean, or null | ||
set.members[].identifier[] |
string, or number, or boolean | ||
set.members[].issuedAt |
number | ||
set.members[].jkt |
string | ||
set.members[].jti |
list, or string, or number, or boolean, or null | ||
set.members[].jti[] |
string, or number, or boolean | ||
set.members[].key |
string | ||
set.members[].kind |
string | access_token, id_token, refresh_token, a SAML assertion version, a Kerberos ticket type or an SVID type. | |
set.members[].length |
integer | ||
set.members[].nbf |
number | ||
set.members[].revocable |
boolean | ||
set.members[].revoked |
boolean | ||
set.members[].revokedAt |
number, or null | ||
set.members[].revokedVia |
string | ||
set.members[].scope |
list, or string, or number, or boolean, or null | ||
set.members[].scope[] |
string, or number, or boolean | ||
set.members[].sessionId |
string | ||
set.members[].setId |
string | ||
set.members[].state |
string | valid, expired, revoked, “not yet valid” or “no expiry stated”. | |
set.members[].sub |
list, or string, or number, or boolean, or null | ||
set.members[].sub[] |
string, or number, or boolean | ||
set.members[].typ |
list, or string, or number, or boolean, or null | ||
set.members[].typ[] |
string, or number, or boolean | ||
set.members[].username |
list, or string, or number, or boolean, or null | ||
set.members[].username[] |
string, or number, or boolean | ||
set.revocableCount |
integer | ||
set.revokedCount |
integer | ||
set.scope |
list, or string, or number, or boolean, or null | ||
set.scope[] |
string, or number, or boolean | ||
set.sessionAuthenticated |
boolean | ||
set.sessionId |
string | ||
set.setId |
string | ||
set.setKey |
string | ||
set.size |
integer | ||
set.state |
string | ||
set.states |
map | How many members are in each state. | |
set.states.{key} |
integer | ||
set.sub |
list, or string, or number, or boolean, or null | ||
set.sub[] |
string, or number, or boolean | ||
set.username |
list, or string, or number, or boolean, or null | ||
set.username[] |
string, or number, or boolean | ||
setKey |
string, or null | ||
why |
string, or null |
GET /admin-api/used-assertions
getUsedAssertions
Every RFC 7523 and RFC 7522 assertion this realm has accepted and that has not yet expired
The used-assertion history: every RFC 7523 JWT and RFC 7522 SAML assertion accepted in THIS REALM — as client authentication (client_assertion) or as an authorization grant (assertion) — and not yet expired, newest first, filtered and paged.
AN ASSERTION IS ACCEPTED ONCE, EVER. One history for both uses and both profiles, keyed by format, issuer and jti/ID, so a JWT that authenticated a client is refused as a grant and the reverse. state is reserved while the token request it came with has not finished, and spent once that response was a 2xx; a request that failed for another reason releases the assertion and it is not listed.
persistent says whether the history survives a restart (it does in the ldif and postgres stores, in both modes), and atomicAcrossProcesses whether recording a use is one claim every process agrees on at once (postgres). A row is kept until expiresAt — the assertion’s own expiry plus the skew allowed when it was read — and live is how many are held against cap (oauth2.assertionReplayCacheSize). No assertion and no credential is in any row.
Since 2026-09-17 (#35) it also holds the jti of every RFC 9101 request object an authorization response was issued on, or a pushed authorization request kept, with use request-object and the client as issuer.
READ ONLY.
Mirrors GET /admin/used-assertions on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
q |
query | string | Substring of the issuer, the jti or ID, the client or the subject, case-insensitive. |
|
format |
query | one of jwt, openid2, saml, saml11, saml-message, attestation-challenge, wss-message |
jwt (RFC 7523) or saml (RFC 7522). |
|
use |
query | one of steam-assertion, client-authentication, authorization-grant, federated-sign-in, request-object, ciba-request, federated-logout, provider-notification, client-attestation-pop, token-exchange, wstrust-requester |
What the assertion was accepted AS — request-object is an RFC 9101 request object whose jti was spent (#35). |
|
state |
query | one of reserved, spent |
reserved (its token request has not finished) or spent (tokens were issued). |
|
page |
query | integer | Which page of the match to return. CLAMPED rather than refused: a page past the end returns the last one, and the reply says which page it actually is. | |
per |
query | integer | Rows per page. Defaults to 50 and is capped at 300. On a drill-down it is SHARED by every list in the reply, which each carry a page number of their own. | |
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
200: This realm’s unexpired used assertions, where the history is held, and the paging that found them.
| Member | Type | Required | What it is |
|---|---|---|---|
atomicAcrossProcesses |
boolean | ||
cap |
number | ||
filter |
object | ||
filter.format |
string | ||
filter.q |
string | ||
filter.state |
string | ||
filter.use |
string | ||
firstRow |
integer | ||
formats |
map | Each format and what it is called. | |
formats.{key} |
string | ||
lastRow |
integer | ||
live |
number | ||
matched |
integer | ||
noun |
string | ||
page |
integer | ||
pages |
integer | ||
paging |
object | ||
paging.firstRow |
integer | ||
paging.lastRow |
integer | ||
paging.noun |
string | ||
paging.page |
integer | ||
paging.pages |
integer | ||
paging.param |
string | ||
paging.perPage |
integer | ||
paging.total |
integer | ||
param |
string | ||
perPage |
integer | ||
persistent |
boolean | ||
rows |
list | ||
rows[].clientId |
string | ||
rows[].expiresAt |
number | ||
rows[].format |
string | ||
rows[].formatLabel |
string | ||
rows[].identifier |
string | ||
rows[].issuer |
string | ||
rows[].origin |
string | ||
rows[].spentAt |
number | ||
rows[].state |
string | ||
rows[].subject |
string | ||
rows[].use |
string | ||
rows[].useLabel |
string | ||
rows[].usedAt |
number | ||
searchNote |
string | ||
shown |
integer | ||
states |
map | Each state and what it means. | |
states.{key} |
string | ||
store |
string | ||
storeNote |
string | ||
total |
integer | ||
uses |
map | Each use and what it is called. | |
uses.{key} |
string |
400: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |