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/logout
getLiveSessions
Everything this service is still holding for one identity, across every protocol family
The protocol-independent view of a person’s live state. Without user it is the FAMILY LIST — what a logout can reach, what it cannot, and why — which is the same prose /logout and /admin/logout print, read off one table in logout/logout.ts rather than copied here.
With user it is that identity: every browser sign-on session, every relying party, realm and service provider signed into on one, every token still revocable, every outstanding authorization and pre-authorized code, every directory connection bound as them, and the Kerberos sign-out instant.
The rows that CANNOT be ended are in the reply on purpose and carry terminable: false with a why. A SAML assertion already issued, a Kerberos service ticket already in a cache and an X509-SVID already minted cannot be recalled by this service or by a real one — nothing consults the issuer when they are presented — and a reply that omitted them would make a global logout look complete when it is not.
The identity is a QUERY PARAMETER and not a path segment for the reason /admin-api/users gives: the identities here contain the characters a path is made of.
Mirrors GET /admin/logout on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
user |
query | string | The identity to look at, as typed. It is normalised the way every other door here normalises one, so alice, alice@REALM and a urn: subject are one answer. |
|
family |
query | string | Only rows of this family. The families member of the reply says which values there are; it is read off the same table the endpoint acts on, so a family that cannot occur is never offered. |
|
deliveryState |
query | one of pending, sent, dead |
Only back-channel Logout Token deliveries in this state. dead is the dead-letter list, whose rows POST /admin-api/logout/retry-backchannel sends again. |
|
deliveryq |
query | string | Only deliveries whose client, session, address, error code or person contains this. | |
backchannelDeliveriesPage |
query | integer | Which page of the deliveries. Clamped, like every page parameter here; per is shared with the live rows. |
|
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 family list, or one identity’s live state.
| Member | Type | Required | What it is |
|---|---|---|---|
at |
number | ||
backchannelCounts |
map | ||
backchannelCounts.{key} |
number | ||
backchannelDeliveries |
list | ||
backchannelDeliveries[].attempts |
number | ||
backchannelDeliveries[].clientId |
string | ||
backchannelDeliveries[].encrypted |
string | ||
backchannelDeliveries[].errorCode |
string, or null | ||
backchannelDeliveries[].finishedAt |
string | ||
backchannelDeliveries[].generation |
number | ||
backchannelDeliveries[].holder |
string | ||
backchannelDeliveries[].id |
string | ||
backchannelDeliveries[].inFlight |
boolean | ||
backchannelDeliveries[].iss |
string | ||
backchannelDeliveries[].lastAttemptAt |
string | ||
backchannelDeliveries[].nextAttemptAt |
string | ||
backchannelDeliveries[].queuedAt |
string | ||
backchannelDeliveries[].realm |
string | ||
backchannelDeliveries[].sessionId |
string | ||
backchannelDeliveries[].sessionRequired |
boolean | ||
backchannelDeliveries[].sid |
string | ||
backchannelDeliveries[].state |
string | ||
backchannelDeliveries[].status |
number, or null | ||
backchannelDeliveries[].sub |
string | ||
backchannelDeliveries[].trigger |
string | ||
backchannelDeliveries[].uri |
string | ||
backchannelDeliveries[].via |
string | ||
backchannelDeliveries[].why |
string, or null | ||
backchannelDeliveriesPaging |
object | ||
backchannelDeliveriesPaging.firstRow |
integer | ||
backchannelDeliveriesPaging.lastRow |
integer | ||
backchannelDeliveriesPaging.noun |
string | ||
backchannelDeliveriesPaging.page |
integer | ||
backchannelDeliveriesPaging.pages |
integer | ||
backchannelDeliveriesPaging.param |
string | ||
backchannelDeliveriesPaging.perPage |
integer | ||
backchannelDeliveriesPaging.total |
integer | ||
canWrite |
boolean | ||
deliveryState |
string | ||
deliveryq |
string | ||
error |
string | ||
families |
list | ||
families[].failure |
string | ||
families[].held |
number | ||
families[].id |
string | ||
families[].label |
string | ||
families[].notListed |
number | ||
families[].protocol |
string | ||
families[].rows |
list | ||
families[].rows[].detail |
string | ||
families[].rows[].expiresAt |
number | ||
families[].rows[].family |
string | ||
families[].rows[].handle |
string | ||
families[].rows[].id |
string | ||
families[].rows[].kind |
string | ||
families[].rows[].label |
string | ||
families[].rows[].sessionId |
string | ||
families[].rows[].startedAt |
number | ||
families[].rows[].terminable |
boolean | ||
families[].rows[].why |
string | ||
families[].spec |
string | ||
families[].terminable |
boolean | ||
families[].what |
string | ||
family |
string | ||
hasReader |
boolean | ||
kerberosRealm |
string | ||
key |
string | ||
known |
boolean | ||
listed |
number | ||
maxRows |
number | ||
notListed |
number | ||
opensTestControls |
boolean | ||
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 | ||
rows |
list | ||
rows[].detail |
string | ||
rows[].expiresAt |
number | ||
rows[].family |
string | ||
rows[].familyLabel |
string | ||
rows[].handle |
string | ||
rows[].id |
string | ||
rows[].kind |
string | ||
rows[].label |
string | ||
rows[].sessionId |
string | ||
rows[].startedAt |
number | ||
rows[].terminable |
boolean | ||
rows[].user |
string | ||
rows[].why |
string | ||
sessions |
number | ||
settings |
object | ||
settings.context |
object | ||
settings.context.configFile |
string, or null | ||
settings.context.defaultsFile |
string, or null | ||
settings.context.inRealm |
boolean | ||
settings.context.persistenceMode |
string | ||
settings.context.persistsAppconfig |
boolean | ||
settings.context.persistsRealms |
boolean | ||
settings.context.realmId |
string | ||
settings.editableCount |
integer | ||
settings.groups |
list | ||
settings.groups[].group |
string | ||
settings.groups[].settings |
list | ||
settings.groups[].settings[].appconfigPath |
string | ||
settings.groups[].settings[].csvValueNotes |
map | ||
settings.groups[].settings[].csvValueNotes.{key} |
string | ||
settings.groups[].settings[].csvValues |
list | ||
settings.groups[].settings[].csvValues[] |
string, or number, or boolean, or null | ||
settings.groups[].settings[].default |
list, or string, or number, or boolean, or null | ||
settings.groups[].settings[].default[] |
string, or number, or boolean, or null | ||
settings.groups[].settings[].description |
string | ||
settings.groups[].settings[].editRefusal |
string | ||
settings.groups[].settings[].editable |
boolean | ||
settings.groups[].settings[].enumValues |
list | ||
settings.groups[].settings[].enumValues[] |
string, or number, or boolean, or null | ||
settings.groups[].settings[].env |
list, or string | ||
settings.groups[].settings[].env[] |
string | ||
settings.groups[].settings[].group |
string | ||
settings.groups[].settings[].key |
string | ||
settings.groups[].settings[].label |
string | ||
settings.groups[].settings[].legacyEnv |
list, or string | ||
settings.groups[].settings[].legacyEnv[] |
string | ||
settings.groups[].settings[].masked |
boolean | ||
settings.groups[].settings[].max |
number | ||
settings.groups[].settings[].min |
number | ||
settings.groups[].settings[].ordered |
boolean | ||
settings.groups[].settings[].overridden |
boolean | ||
settings.groups[].settings[].realmSettable |
boolean | ||
settings.groups[].settings[].restartReason |
string | ||
settings.groups[].settings[].selectAll |
object | ||
settings.groups[].settings[].selectAll.aloneWhileOn |
list | ||
settings.groups[].settings[].selectAll.aloneWhileOn[].canBeOn |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.aloneWhileOn[].on |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.aloneWhileOn[].setting |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.aloneWhileOn[].values |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.onlyWhileOn |
list | ||
settings.groups[].settings[].selectAll.onlyWhileOn[].canBeOn |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.onlyWhileOn[].on |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.onlyWhileOn[].setting |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.onlyWhileOn[].values |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].source |
string | ||
settings.groups[].settings[].step |
number | ||
settings.groups[].settings[].text |
string, or null | ||
settings.groups[].settings[].type |
string | ||
settings.groups[].settings[].value |
list, or string, or number, or boolean, or null | ||
settings.groups[].settings[].value[] |
string, or number, or boolean, or null | ||
settings.overridden |
list | ||
settings.overridden[] |
string | ||
settings.page |
string | ||
settings.setWith |
string | ||
settings.settingCount |
integer | ||
settings.sharedWith |
map | ||
settings.sharedWith.{key} |
list | ||
settings.sharedWith.{key}[] |
object, or string | ||
settings.sharedWith.{key}[].label |
string | ||
settings.sharedWith.{key}[].path |
string | ||
total |
number | ||
user |
string |
400: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/logout/end
endLiveSessions
End named items and nothing else
The selective half. select carries row ids from the GET — session:<id>, token:<jti>, wsfed-rp:<session>|<realm>, and so on.
An empty select is REFUSED here and is a global logout at POST /logout, which is the one place the two doors differ and is deliberate: an empty selection arriving at this operation is a caller that built a list and got nothing, where an empty body at /logout is a caller asking for everything. Same absence, opposite intent.
Ids are re-resolved against what is live NOW rather than trusted, so an id that has since been redeemed or expired ends nothing and is answered in unknown or skipped rather than ending something else.
Mirrors POST /admin/logout 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 |
|---|---|---|---|
select |
list | yes | Row ids from GET /admin-api/logout?user=. |
select[] |
string | ||
user |
string | yes | The identity to act on. |
200: The act, in result.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
result |
object | ||
result.acrossCluster |
list | ||
result.acrossCluster[].at |
string, or number, or null | ||
result.acrossCluster[].family |
string | ||
result.acrossCluster[].message |
string | ||
result.backchannel |
list | ||
result.backchannel[].attempts |
number | ||
result.backchannel[].clientId |
string | ||
result.backchannel[].encrypted |
string | ||
result.backchannel[].finishedAt |
string | ||
result.backchannel[].generation |
number | ||
result.backchannel[].holder |
string | ||
result.backchannel[].id |
string | ||
result.backchannel[].inFlight |
boolean | ||
result.backchannel[].iss |
string | ||
result.backchannel[].lastAttemptAt |
string | ||
result.backchannel[].nextAttemptAt |
string | ||
result.backchannel[].queuedAt |
string | ||
result.backchannel[].realm |
string | ||
result.backchannel[].sessionId |
string | ||
result.backchannel[].sessionRequired |
boolean | ||
result.backchannel[].sid |
string | ||
result.backchannel[].state |
string | ||
result.backchannel[].status |
number, or null | ||
result.backchannel[].sub |
string | ||
result.backchannel[].trigger |
string | ||
result.backchannel[].uri |
string | ||
result.backchannel[].via |
string | ||
result.backchannel[].why |
string, or null | ||
result.cleanups |
list | ||
result.cleanups[].realm |
string | ||
result.cleanups[].url |
string | ||
result.cleanups[].why |
string | ||
result.cleanups[].wreply |
string | ||
result.key |
string | ||
result.logoutRequests |
list | ||
result.logoutRequests[].destination |
string | ||
result.logoutRequests[].entityId |
string | ||
result.logoutRequests[].from |
string | ||
result.logoutRequests[].url |
string | ||
result.logoutRequests[].why |
string | ||
result.message |
string | ||
result.notifications |
list | ||
result.notifications[].clientId |
string | ||
result.notifications[].sessionRequired |
boolean | ||
result.notifications[].uri |
string | ||
result.notifications[].url |
string | ||
result.notifications[].why |
string | ||
result.ok |
boolean | ||
result.partnerLogouts |
list | ||
result.partnerLogouts[].action |
string | ||
result.partnerLogouts[].fields |
map | ||
result.partnerLogouts[].fields.{key} |
string | ||
result.partnerLogouts[].kind |
string | ||
result.partnerLogouts[].label |
string | ||
result.partnerLogouts[].protocol |
string | ||
result.partnerLogouts[].relationship |
string | ||
result.partnerLogouts[].url |
string | ||
result.partnerLogouts[].what |
string | ||
result.scope |
string | ||
result.skipped |
list | ||
result.skipped[].family |
string | ||
result.skipped[].id |
string | ||
result.skipped[].kind |
string | ||
result.skipped[].label |
string | ||
result.skipped[].message |
string | ||
result.skipped[].pending |
boolean | ||
result.terminated |
list | ||
result.terminated[].family |
string | ||
result.terminated[].id |
string | ||
result.terminated[].kind |
string | ||
result.terminated[].label |
string | ||
result.terminated[].message |
string | ||
result.terminated[].pending |
boolean | ||
result.unknown |
list | ||
result.unknown[] |
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 | |
result |
object | ||
result.acrossCluster |
list | ||
result.acrossCluster[].at |
string, or number, or null | ||
result.acrossCluster[].family |
string | ||
result.acrossCluster[].message |
string | ||
result.backchannel |
list | ||
result.backchannel[].attempts |
number | ||
result.backchannel[].clientId |
string | ||
result.backchannel[].encrypted |
string | ||
result.backchannel[].finishedAt |
string | ||
result.backchannel[].generation |
number | ||
result.backchannel[].holder |
string | ||
result.backchannel[].id |
string | ||
result.backchannel[].inFlight |
boolean | ||
result.backchannel[].iss |
string | ||
result.backchannel[].lastAttemptAt |
string | ||
result.backchannel[].nextAttemptAt |
string | ||
result.backchannel[].queuedAt |
string | ||
result.backchannel[].realm |
string | ||
result.backchannel[].sessionId |
string | ||
result.backchannel[].sessionRequired |
boolean | ||
result.backchannel[].sid |
string | ||
result.backchannel[].state |
string | ||
result.backchannel[].status |
number, or null | ||
result.backchannel[].sub |
string | ||
result.backchannel[].trigger |
string | ||
result.backchannel[].uri |
string | ||
result.backchannel[].via |
string | ||
result.backchannel[].why |
string, or null | ||
result.cleanups |
list | ||
result.cleanups[].realm |
string | ||
result.cleanups[].url |
string | ||
result.cleanups[].why |
string | ||
result.cleanups[].wreply |
string | ||
result.key |
string | ||
result.logoutRequests |
list | ||
result.logoutRequests[].destination |
string | ||
result.logoutRequests[].entityId |
string | ||
result.logoutRequests[].from |
string | ||
result.logoutRequests[].url |
string | ||
result.logoutRequests[].why |
string | ||
result.message |
string | ||
result.notifications |
list | ||
result.notifications[].clientId |
string | ||
result.notifications[].sessionRequired |
boolean | ||
result.notifications[].uri |
string | ||
result.notifications[].url |
string | ||
result.notifications[].why |
string | ||
result.ok |
boolean | ||
result.partnerLogouts |
list | ||
result.partnerLogouts[].action |
string | ||
result.partnerLogouts[].fields |
map | ||
result.partnerLogouts[].fields.{key} |
string | ||
result.partnerLogouts[].kind |
string | ||
result.partnerLogouts[].label |
string | ||
result.partnerLogouts[].protocol |
string | ||
result.partnerLogouts[].relationship |
string | ||
result.partnerLogouts[].url |
string | ||
result.partnerLogouts[].what |
string | ||
result.scope |
string | ||
result.skipped |
list | ||
result.skipped[].family |
string | ||
result.skipped[].id |
string | ||
result.skipped[].kind |
string | ||
result.skipped[].label |
string | ||
result.skipped[].message |
string | ||
result.skipped[].pending |
boolean | ||
result.terminated |
list | ||
result.terminated[].family |
string | ||
result.terminated[].id |
string | ||
result.terminated[].kind |
string | ||
result.terminated[].label |
string | ||
result.terminated[].message |
string | ||
result.terminated[].pending |
boolean | ||
result.unknown |
list | ||
result.unknown[] |
string |
POST /admin-api/logout/global
globalLogout
End everything this service holds for one identity
The default a person gets from POST /logout with an empty body, driven by name. Every browser sign-on session, every relying party, realm and service provider on one, every revocable token, every outstanding code, every directory connection bound as them, and a Kerberos sign-out instant after which a TGS-REQ carrying an older ticket is refused KDC_ERR_TGT_REVOKED (20).
What it cannot do is reported rather than skipped. The reply’s skipped array names every live thing that survived and says why.
What it cannot do FROM HERE is different and is also in the reply. A front-channel logout notification is an iframe in the signed-out person’s own browser and a WS-Federation cleanup is an image in it; neither is something this process performs. They come back in notifications and cleanups so a caller can load them, and /logout is the page where a browser does it by itself.
The back-channel Logout Tokens ARE sent from here (OpenID Connect Back-Channel Logout 1.0), to every relying party on an ended session that registered a backchannel_logout_uri — after this reply, so backchannel lists each with the state it has now, nearly always pending, and GET /admin-api/logout lists where each got to.
Mirrors POST /admin/logout 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 | The identity to sign out, as typed. Normalised the way the GET normalises one. |
200: The act, in result: terminated, skipped, unknown, the three fan-outs a browser has to perform, and backchannel, the one this service performs itself.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
result |
object | ||
result.acrossCluster |
list | ||
result.acrossCluster[].at |
string, or number, or null | ||
result.acrossCluster[].family |
string | ||
result.acrossCluster[].message |
string | ||
result.backchannel |
list | ||
result.backchannel[].attempts |
number | ||
result.backchannel[].clientId |
string | ||
result.backchannel[].encrypted |
string | ||
result.backchannel[].finishedAt |
string | ||
result.backchannel[].generation |
number | ||
result.backchannel[].holder |
string | ||
result.backchannel[].id |
string | ||
result.backchannel[].inFlight |
boolean | ||
result.backchannel[].iss |
string | ||
result.backchannel[].lastAttemptAt |
string | ||
result.backchannel[].nextAttemptAt |
string | ||
result.backchannel[].queuedAt |
string | ||
result.backchannel[].realm |
string | ||
result.backchannel[].sessionId |
string | ||
result.backchannel[].sessionRequired |
boolean | ||
result.backchannel[].sid |
string | ||
result.backchannel[].state |
string | ||
result.backchannel[].status |
number, or null | ||
result.backchannel[].sub |
string | ||
result.backchannel[].trigger |
string | ||
result.backchannel[].uri |
string | ||
result.backchannel[].via |
string | ||
result.backchannel[].why |
string, or null | ||
result.cleanups |
list | ||
result.cleanups[].realm |
string | ||
result.cleanups[].url |
string | ||
result.cleanups[].why |
string | ||
result.cleanups[].wreply |
string | ||
result.key |
string | ||
result.logoutRequests |
list | ||
result.logoutRequests[].destination |
string | ||
result.logoutRequests[].entityId |
string | ||
result.logoutRequests[].from |
string | ||
result.logoutRequests[].url |
string | ||
result.logoutRequests[].why |
string | ||
result.message |
string | ||
result.notifications |
list | ||
result.notifications[].clientId |
string | ||
result.notifications[].sessionRequired |
boolean | ||
result.notifications[].uri |
string | ||
result.notifications[].url |
string | ||
result.notifications[].why |
string | ||
result.ok |
boolean | ||
result.partnerLogouts |
list | ||
result.partnerLogouts[].action |
string | ||
result.partnerLogouts[].fields |
map | ||
result.partnerLogouts[].fields.{key} |
string | ||
result.partnerLogouts[].kind |
string | ||
result.partnerLogouts[].label |
string | ||
result.partnerLogouts[].protocol |
string | ||
result.partnerLogouts[].relationship |
string | ||
result.partnerLogouts[].url |
string | ||
result.partnerLogouts[].what |
string | ||
result.scope |
string | ||
result.skipped |
list | ||
result.skipped[].family |
string | ||
result.skipped[].id |
string | ||
result.skipped[].kind |
string | ||
result.skipped[].label |
string | ||
result.skipped[].message |
string | ||
result.skipped[].pending |
boolean | ||
result.terminated |
list | ||
result.terminated[].family |
string | ||
result.terminated[].id |
string | ||
result.terminated[].kind |
string | ||
result.terminated[].label |
string | ||
result.terminated[].message |
string | ||
result.terminated[].pending |
boolean | ||
result.unknown |
list | ||
result.unknown[] |
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 | |
result |
object | ||
result.acrossCluster |
list | ||
result.acrossCluster[].at |
string, or number, or null | ||
result.acrossCluster[].family |
string | ||
result.acrossCluster[].message |
string | ||
result.backchannel |
list | ||
result.backchannel[].attempts |
number | ||
result.backchannel[].clientId |
string | ||
result.backchannel[].encrypted |
string | ||
result.backchannel[].finishedAt |
string | ||
result.backchannel[].generation |
number | ||
result.backchannel[].holder |
string | ||
result.backchannel[].id |
string | ||
result.backchannel[].inFlight |
boolean | ||
result.backchannel[].iss |
string | ||
result.backchannel[].lastAttemptAt |
string | ||
result.backchannel[].nextAttemptAt |
string | ||
result.backchannel[].queuedAt |
string | ||
result.backchannel[].realm |
string | ||
result.backchannel[].sessionId |
string | ||
result.backchannel[].sessionRequired |
boolean | ||
result.backchannel[].sid |
string | ||
result.backchannel[].state |
string | ||
result.backchannel[].status |
number, or null | ||
result.backchannel[].sub |
string | ||
result.backchannel[].trigger |
string | ||
result.backchannel[].uri |
string | ||
result.backchannel[].via |
string | ||
result.backchannel[].why |
string, or null | ||
result.cleanups |
list | ||
result.cleanups[].realm |
string | ||
result.cleanups[].url |
string | ||
result.cleanups[].why |
string | ||
result.cleanups[].wreply |
string | ||
result.key |
string | ||
result.logoutRequests |
list | ||
result.logoutRequests[].destination |
string | ||
result.logoutRequests[].entityId |
string | ||
result.logoutRequests[].from |
string | ||
result.logoutRequests[].url |
string | ||
result.logoutRequests[].why |
string | ||
result.message |
string | ||
result.notifications |
list | ||
result.notifications[].clientId |
string | ||
result.notifications[].sessionRequired |
boolean | ||
result.notifications[].uri |
string | ||
result.notifications[].url |
string | ||
result.notifications[].why |
string | ||
result.ok |
boolean | ||
result.partnerLogouts |
list | ||
result.partnerLogouts[].action |
string | ||
result.partnerLogouts[].fields |
map | ||
result.partnerLogouts[].fields.{key} |
string | ||
result.partnerLogouts[].kind |
string | ||
result.partnerLogouts[].label |
string | ||
result.partnerLogouts[].protocol |
string | ||
result.partnerLogouts[].relationship |
string | ||
result.partnerLogouts[].url |
string | ||
result.partnerLogouts[].what |
string | ||
result.scope |
string | ||
result.skipped |
list | ||
result.skipped[].family |
string | ||
result.skipped[].id |
string | ||
result.skipped[].kind |
string | ||
result.skipped[].label |
string | ||
result.skipped[].message |
string | ||
result.skipped[].pending |
boolean | ||
result.terminated |
list | ||
result.terminated[].family |
string | ||
result.terminated[].id |
string | ||
result.terminated[].kind |
string | ||
result.terminated[].label |
string | ||
result.terminated[].message |
string | ||
result.terminated[].pending |
boolean | ||
result.unknown |
list | ||
result.unknown[] |
string |
POST /admin-api/logout/restore-kerberos
clearKerberosSignOut
NON-SPEC: clear the Kerberos sign-out instant
Clears the instant a logout stamped on the principal, so a ticket-granting ticket authenticated before it is accepted again.
DEVELOPMENT MODE ONLY: product mode refuses it (HTTP 400). A real KDC has no such operation. A fresh AS-REQ gets a ticket newer than the instant but does NOT clear it — tickets from before it stay refused, renewals included, until the latest one of them could still be valid. This exists so a test can put a signed-out ticket back into service without restarting the service.
Mirrors POST /admin/logout 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 | The identity whose principal to clear. |
200: Whether an instant had been set.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
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 | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/logout/restore-token
restoreLoggedOutToken
NON-SPEC: un-revoke a token a logout revoked
No authorization server could offer this. RFC 7009 defines no such operation and a real deployment could not have one, because a resource server may already have cached the refusal. It is here for the reason POST /admin-api/tokens/restore is — it is the same function against the same revocation set — and that reason is that restarting this service to get back to a working token turns a two-second test into a two-minute one.
Mirrors POST /admin/logout 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 | yes | The token to restore. |
user |
string | yes | The identity, for the audit row. |
200: Whether it had been revoked.
| 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/logout/retry-backchannel
retryBackchannelDelivery
Send a dead back-channel Logout Token delivery again
A delivery that ended as a DEAD LETTER — refused with 400, refused by the outbound policy, or still failing after oauth2.backchannelLogoutAttempts — is queued again as a new generation: a new Logout Token with a new jti, a fresh attempt budget, and the client’s CURRENT backchannel_logout_uri, because the commonest reason to retry is having corrected it. The attempt is made after this reply, claimed like every other, so exactly one node sends it. Refused for a delivery that is not dead, one retention has removed, and a client with no usable address. GET /admin-api/logout?deliveryState=dead lists the dead letters.
Mirrors POST /admin/logout 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 |
|---|---|---|---|
delivery |
string | yes | The delivery’s id, from backchannelDeliveries. |
200: The delivery as it now stands, pending.
| Member | Type | Required | What it is |
|---|---|---|---|
delivery |
object | ||
delivery.attempts |
number | ||
delivery.clientId |
string | ||
delivery.encrypted |
string | ||
delivery.finishedAt |
string | ||
delivery.generation |
number | ||
delivery.holder |
string | ||
delivery.id |
string | ||
delivery.inFlight |
boolean | ||
delivery.iss |
string | ||
delivery.lastAttemptAt |
string | ||
delivery.nextAttemptAt |
string | ||
delivery.queuedAt |
string | ||
delivery.realm |
string | ||
delivery.sessionId |
string | ||
delivery.sessionRequired |
boolean | ||
delivery.sid |
string | ||
delivery.state |
string | ||
delivery.status |
number, or null | ||
delivery.sub |
string | ||
delivery.trigger |
string | ||
delivery.uri |
string | ||
delivery.via |
string | ||
delivery.why |
string, or null | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
delivery |
object | ||
delivery.attempts |
number | ||
delivery.clientId |
string | ||
delivery.encrypted |
string | ||
delivery.finishedAt |
string | ||
delivery.generation |
number | ||
delivery.holder |
string | ||
delivery.id |
string | ||
delivery.inFlight |
boolean | ||
delivery.iss |
string | ||
delivery.lastAttemptAt |
string | ||
delivery.nextAttemptAt |
string | ||
delivery.queuedAt |
string | ||
delivery.realm |
string | ||
delivery.sessionId |
string | ||
delivery.sessionRequired |
boolean | ||
delivery.sid |
string | ||
delivery.state |
string | ||
delivery.status |
number, or null | ||
delivery.sub |
string | ||
delivery.trigger |
string | ||
delivery.uri |
string | ||
delivery.via |
string | ||
delivery.why |
string, or null | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |