This is the documentation of iya-sts 1.0.0. The latest is 1.1.0.
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/caep
getCaep
The CAEP session register: what state each session is in and how many events of which type have been sent about it
Everything /admin/caep and /admin/caep-sessions draw, as JSON. Per session: who it belongs to, when it was established, the CAEP state it is in — established, presented, revoked — its assurance level, its device compliance, its risk level, the claims that have changed, and a count per event type.
THE REGISTER OUTLIVES THE SESSION AND THAT IS THE POINT. The session store forgets one the moment it is signed out, so a row saying revoked is the only remaining evidence that it existed and was revoked.
CAEP IS A VOCABULARY AND NOT A FAMILY. Its events travel on SSF streams, are signed by the SSF signer and are delivered by the two SSF deliveries, so GET /admin-api/ssf is where the streams themselves are. streams here says only which of them would take a CAEP event at all, because a session with a count of zero almost always means nobody asked for that type — and SSF gives a receiver no other notice of that.
Mirrors GET /admin/caep on the admin console.
Scope: admin:read.
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. |
200: The register, the catalogue and the settings.
| Member | Type | Required | What it is |
|---|---|---|---|
applications |
list | ||
applications[].accounts |
integer | ||
applications[].acknowledged |
integer | ||
applications[].audiences |
list | ||
applications[].audiences[] |
string | ||
applications[].counts |
map | ||
applications[].counts.{key} |
number | ||
applications[].declared |
boolean | ||
applications[].delivered |
integer | ||
applications[].deliveries |
list | ||
applications[].deliveries[] |
string | ||
applications[].dn |
string | ||
applications[].enabled |
integer | ||
applications[].endpoints |
list | ||
applications[].endpoints[] |
string | ||
applications[].failed |
integer | ||
applications[].identifier |
string | ||
applications[].lastPushAt |
string, or number, or null | ||
applications[].lastPushError |
string, or null | ||
applications[].name |
string, or null | ||
applications[].queued |
integer | ||
applications[].receiverErrors |
integer | ||
applications[].registered |
boolean | ||
applications[].sessions |
integer | ||
applications[].streamCount |
integer | ||
applications[].streams |
list | ||
applications[].streams[] |
string | ||
applications[].takes |
list | ||
applications[].takes[] |
string | ||
applications[].total |
integer | ||
autoEmit |
boolean | ||
autoEmitActs |
list | ||
autoEmitActs[] |
string | ||
cap |
number | ||
catalogue |
list | ||
catalogue[].deprecated |
string | ||
catalogue[].family |
string | ||
catalogue[].members |
list | ||
catalogue[].members[].name |
string | ||
catalogue[].members[].required |
boolean, or string, or null | ||
catalogue[].members[].type |
string, or null | ||
catalogue[].members[].values |
list | ||
catalogue[].members[].values[] |
string | ||
catalogue[].members[].what |
string | ||
catalogue[].name |
string | ||
catalogue[].offered |
boolean | ||
catalogue[].required |
list | ||
catalogue[].required[] |
string | ||
catalogue[].short |
string | ||
catalogue[].subject |
boolean, or string, or null | ||
catalogue[].subjectFormats |
list | ||
catalogue[].subjectFormats[] |
string | ||
catalogue[].uri |
string | ||
catalogue[].what |
string | ||
enabled |
boolean | ||
eventTypes |
list | ||
eventTypes[].deprecated |
string | ||
eventTypes[].family |
string | ||
eventTypes[].members |
list | ||
eventTypes[].members[].name |
string | ||
eventTypes[].members[].required |
boolean, or string, or null | ||
eventTypes[].members[].type |
string, or null | ||
eventTypes[].members[].values |
list | ||
eventTypes[].members[].values[] |
string | ||
eventTypes[].members[].what |
string | ||
eventTypes[].name |
string | ||
eventTypes[].offered |
boolean | ||
eventTypes[].required |
list | ||
eventTypes[].required[] |
string | ||
eventTypes[].short |
string | ||
eventTypes[].subject |
boolean, or string, or null | ||
eventTypes[].subjectFormats |
list | ||
eventTypes[].subjectFormats[] |
string | ||
eventTypes[].uri |
string | ||
eventTypes[].what |
string | ||
events |
list | ||
events[].at |
string | ||
events[].jti |
string | ||
events[].name |
string | ||
events[].streamId |
string | ||
events[].uri |
string | ||
events[].warnings |
list | ||
events[].warnings[] |
string | ||
filter |
object | ||
filter.applications |
string, or null | ||
filter.sessions |
string, or null | ||
id |
string | ||
installed |
boolean | ||
issuer |
string | ||
matched |
object | ||
matched.applications |
integer | ||
matched.sessions |
integer | ||
matched.streams |
integer | ||
note |
string | ||
omitEventTimestamp |
boolean | ||
paging |
object | ||
paging.applications |
object | ||
paging.applications.firstRow |
integer | ||
paging.applications.lastRow |
integer | ||
paging.applications.noun |
string | ||
paging.applications.page |
integer | ||
paging.applications.pages |
integer | ||
paging.applications.param |
string | ||
paging.applications.perPage |
integer | ||
paging.applications.total |
integer | ||
paging.events |
object | ||
paging.events.firstRow |
integer | ||
paging.events.lastRow |
integer | ||
paging.events.noun |
string | ||
paging.events.page |
integer | ||
paging.events.pages |
integer | ||
paging.events.param |
string | ||
paging.events.perPage |
integer | ||
paging.events.total |
integer | ||
paging.sessions |
object | ||
paging.sessions.firstRow |
integer | ||
paging.sessions.lastRow |
integer | ||
paging.sessions.noun |
string | ||
paging.sessions.page |
integer | ||
paging.sessions.pages |
integer | ||
paging.sessions.param |
string | ||
paging.sessions.perPage |
integer | ||
paging.sessions.total |
integer | ||
paging.streams |
object | ||
paging.streams.firstRow |
integer | ||
paging.streams.lastRow |
integer | ||
paging.streams.noun |
string | ||
paging.streams.page |
integer | ||
paging.streams.pages |
integer | ||
paging.streams.param |
string | ||
paging.streams.perPage |
integer | ||
paging.streams.total |
integer | ||
session |
object | ||
session.acr |
string, or null | ||
session.amr |
list | ||
session.amr[] |
string | ||
session.assurance |
object | ||
session.assurance.level |
string | ||
session.assurance.namespace |
string | ||
session.assurance.previousLevel |
string | ||
session.claims |
any JSON | The claims a token-claims-change event said changed: whichever a person configured or an emitter named. The claims a token-claims-change event said changed: whichever a person configured or an emitter named. |
|
session.compliance |
string, or null | ||
session.counts |
map | ||
session.counts.{key} |
number | ||
session.credentials |
list | ||
session.credentials[].at |
string | ||
session.credentials[].changeType |
string | ||
session.credentials[].credentialType |
string | ||
session.credentials[].friendlyName |
string | ||
session.establishedAt |
string, or number, or null | ||
session.events |
list | ||
session.events[].at |
string | ||
session.events[].jti |
string | ||
session.events[].name |
string | ||
session.events[].streamId |
string | ||
session.events[].uri |
string | ||
session.events[].warnings |
list | ||
session.events[].warnings[] |
string | ||
session.iss |
string, or null | ||
session.notes |
list | ||
session.notes[] |
string | ||
session.protocol |
string, or null | ||
session.risk |
object | ||
session.risk.level |
string | ||
session.risk.previousLevel |
string | ||
session.risk.reason |
string | ||
session.sessionId |
string | ||
session.state |
string, or null | ||
session.streams |
list | ||
session.streams[] |
string | ||
session.sub |
string, or null | ||
session.subject |
string | ||
session.total |
integer | ||
session.updatedAt |
string, or number, or null | ||
session.username |
string, or null | ||
sessions |
list | ||
sessions[].acr |
string, or null | ||
sessions[].amr |
list | ||
sessions[].amr[] |
string | ||
sessions[].assurance |
object | ||
sessions[].assurance.level |
string | ||
sessions[].assurance.namespace |
string | ||
sessions[].assurance.previousLevel |
string | ||
sessions[].claims |
any JSON | The claims a token-claims-change event said changed: whichever a person configured or an emitter named. The claims a token-claims-change event said changed: whichever a person configured or an emitter named. |
|
sessions[].compliance |
string, or null | ||
sessions[].counts |
map | ||
sessions[].counts.{key} |
number | ||
sessions[].credentials |
list | ||
sessions[].credentials[].at |
string | ||
sessions[].credentials[].changeType |
string | ||
sessions[].credentials[].credentialType |
string | ||
sessions[].credentials[].friendlyName |
string | ||
sessions[].establishedAt |
string, or number, or null | ||
sessions[].events |
list | ||
sessions[].events[].at |
string | ||
sessions[].events[].jti |
string | ||
sessions[].events[].name |
string | ||
sessions[].events[].streamId |
string | ||
sessions[].events[].uri |
string | ||
sessions[].events[].warnings |
list | ||
sessions[].events[].warnings[] |
string | ||
sessions[].iss |
string, or null | ||
sessions[].notes |
list | ||
sessions[].notes[] |
string | ||
sessions[].protocol |
string, or null | ||
sessions[].risk |
object | ||
sessions[].risk.level |
string | ||
sessions[].risk.previousLevel |
string | ||
sessions[].risk.reason |
string | ||
sessions[].sessionId |
string | ||
sessions[].state |
string, or null | ||
sessions[].streams |
list | ||
sessions[].streams[] |
string | ||
sessions[].sub |
string, or null | ||
sessions[].subject |
string | ||
sessions[].total |
integer | ||
sessions[].updatedAt |
string, or number, or null | ||
sessions[].username |
string, or null | ||
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}[].label |
string | ||
settings.sharedWith.{key}[].path |
string | ||
shown |
object | ||
shown.applications |
list | ||
shown.applications[].accounts |
integer | ||
shown.applications[].acknowledged |
integer | ||
shown.applications[].audiences |
list | ||
shown.applications[].audiences[] |
string | ||
shown.applications[].counts |
map | ||
shown.applications[].counts.{key} |
number | ||
shown.applications[].declared |
boolean | ||
shown.applications[].delivered |
integer | ||
shown.applications[].deliveries |
list | ||
shown.applications[].deliveries[] |
string | ||
shown.applications[].dn |
string | ||
shown.applications[].enabled |
integer | ||
shown.applications[].endpoints |
list | ||
shown.applications[].endpoints[] |
string | ||
shown.applications[].failed |
integer | ||
shown.applications[].identifier |
string | ||
shown.applications[].lastPushAt |
string, or number, or null | ||
shown.applications[].lastPushError |
string, or null | ||
shown.applications[].name |
string, or null | ||
shown.applications[].queued |
integer | ||
shown.applications[].receiverErrors |
integer | ||
shown.applications[].registered |
boolean | ||
shown.applications[].sessions |
integer | ||
shown.applications[].streamCount |
integer | ||
shown.applications[].streams |
list | ||
shown.applications[].streams[] |
string | ||
shown.applications[].takes |
list | ||
shown.applications[].takes[] |
string | ||
shown.applications[].total |
integer | ||
shown.sessions |
list | ||
shown.sessions[].acr |
string, or null | ||
shown.sessions[].amr |
list | ||
shown.sessions[].amr[] |
string | ||
shown.sessions[].assurance |
object | ||
shown.sessions[].assurance.level |
string | ||
shown.sessions[].assurance.namespace |
string | ||
shown.sessions[].assurance.previousLevel |
string | ||
shown.sessions[].claims |
any JSON | The claims a token-claims-change event said changed: whichever a person configured or an emitter named. The claims a token-claims-change event said changed: whichever a person configured or an emitter named. |
|
shown.sessions[].compliance |
string, or null | ||
shown.sessions[].counts |
map | ||
shown.sessions[].counts.{key} |
number | ||
shown.sessions[].credentials |
list | ||
shown.sessions[].credentials[].at |
string | ||
shown.sessions[].credentials[].changeType |
string | ||
shown.sessions[].credentials[].credentialType |
string | ||
shown.sessions[].credentials[].friendlyName |
string | ||
shown.sessions[].establishedAt |
string, or number, or null | ||
shown.sessions[].events |
list | ||
shown.sessions[].events[].at |
string | ||
shown.sessions[].events[].jti |
string | ||
shown.sessions[].events[].name |
string | ||
shown.sessions[].events[].streamId |
string | ||
shown.sessions[].events[].uri |
string | ||
shown.sessions[].events[].warnings |
list | ||
shown.sessions[].events[].warnings[] |
string | ||
shown.sessions[].iss |
string, or null | ||
shown.sessions[].notes |
list | ||
shown.sessions[].notes[] |
string | ||
shown.sessions[].protocol |
string, or null | ||
shown.sessions[].risk |
object | ||
shown.sessions[].risk.level |
string | ||
shown.sessions[].risk.previousLevel |
string | ||
shown.sessions[].risk.reason |
string | ||
shown.sessions[].sessionId |
string | ||
shown.sessions[].state |
string, or null | ||
shown.sessions[].streams |
list | ||
shown.sessions[].streams[] |
string | ||
shown.sessions[].sub |
string, or null | ||
shown.sessions[].subject |
string | ||
shown.sessions[].total |
integer | ||
shown.sessions[].updatedAt |
string, or number, or null | ||
shown.sessions[].username |
string, or null | ||
shown.streams |
list | ||
shown.streams[].aud |
list, or string, or null | ||
shown.streams[].aud[] |
string | ||
shown.streams[].delivery |
string | ||
shown.streams[].status |
string | ||
shown.streams[].stream_id |
string | ||
shown.streams[].subjects |
integer | ||
shown.streams[].takes |
list | ||
shown.streams[].takes[] |
string | ||
ssfEnabled |
boolean | ||
streamCounts |
object | ||
streamCounts.taking |
integer | ||
streamCounts.total |
integer | ||
streams |
list | ||
streams[].aud |
list, or string, or null | ||
streams[].aud[] |
string | ||
streams[].delivery |
string | ||
streams[].status |
string | ||
streams[].stream_id |
string | ||
streams[].subjects |
integer | ||
streams[].takes |
list | ||
streams[].takes[] |
string | ||
totals |
map | ||
totals.{key} |
number | ||
tracked |
integer |
POST /admin-api/caep/clear
clearCaepSessions
Drop every row in the CAEP session register
Forgets what has been said about every session. Nobody is signed out, no stream is touched and no queued event is dropped — those are the SSF half, at POST /admin-api/ssf/delete.
It is worth knowing what this throws away: rows for sessions this service NO LONGER HOLDS are the only evidence that those sessions existed and were revoked, and nothing else in this service records it.
Mirrors POST /admin/caep 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 rows were dropped.
| 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/caep/emit
emitCaepEvent
Send one CAEP event about one session
Builds the payload, adds the four claims CAEP gives every event, composes the SUBJECT from the session — SSF’s complex subject, naming the person AND the session, because the person is not revoked and one session of theirs is — and transmits it on every stream that both delivers the type and covers that subject.
EVERY ONE OF THE EIGHT ALSO FIRES ON ITS OWN when caep.autoEmit is on — device-compliance-change since #164, from the device register — so this is for an event on demand, about a session and with a payload you chose.
A TYPE NO STREAM TAKES IS NOT AN ERROR. The session’s state is still updated and the reply says nothing was sent, because “the event happened and nobody had asked to hear about it” is a different fact from a failure and is the one that is usually true.
Mirrors POST /admin/caep 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 |
|---|---|---|---|
initiating_entity |
one of admin, user, policy, system |
admin | user | policy | system. It is the member that lets a receiver tell “an administrator revoked this” from “a risk engine did”. | |
payload |
string | The event-specific members, as JSON. Empty for a conforming specimen of the type. | |
reason_admin |
string | Why, for a log. Sent as an object keyed by caep.reasonLanguage — CAEP makes it a language map and a string there is the commonest mistake in the profile. |
|
reason_user |
string | The same, in words meant for the person. | |
session_id |
string | yes | The session it is about, from GET /admin-api/caep. |
type |
string | yes | The event type: a short name such as session-revoked, or the whole URI. |
200: How many streams took it, or why none did.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
reports |
list | ||
reports[].claims |
any JSON | A Security Event Token’s claims. An event’s members are each event type’s, and the claims are what was signed, so a model of them here would be a second list of every event type. A Security Event Token’s claims. An event’s members are each event type’s, and the claims are what was signed, so a model of them here would be a second list of every event type. | |
reports[].deadLettered |
boolean | ||
reports[].delivered |
boolean | ||
reports[].err |
string, or null | ||
reports[].held |
boolean | ||
reports[].jti |
string | ||
reports[].ok |
boolean | ||
reports[].status |
integer, or null | ||
reports[].token |
string | ||
reports[].why |
string, or null | ||
warnings |
list | ||
warnings[] |
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 | |
reports |
list | ||
reports[].claims |
any JSON | A Security Event Token’s claims. An event’s members are each event type’s, and the claims are what was signed, so a model of them here would be a second list of every event type. A Security Event Token’s claims. An event’s members are each event type’s, and the claims are what was signed, so a model of them here would be a second list of every event type. | |
reports[].deadLettered |
boolean | ||
reports[].delivered |
boolean | ||
reports[].err |
string, or null | ||
reports[].held |
boolean | ||
reports[].jti |
string | ||
reports[].ok |
boolean | ||
reports[].status |
integer, or null | ||
reports[].token |
string | ||
reports[].why |
string, or null | ||
warnings |
list | ||
warnings[] |
string |
POST /admin-api/caep/reset-session
resetCaepSession
Put one session’s CAEP state back to where it started
Clears the state, the assurance level, the device compliance, the risk level, the changed claims and every counter on one row, keeping the row.
IT SIGNS NOBODY OUT. This register is a record of what has been SAID about a session; resetting it forgets the record. The session itself is untouched and every token issued on it is still good, which is the distinction this whole page rests on.
It is a reset and not a delete because the identity and the sign-in instant are still true — a delete would take the row off the page, which reads as the session having gone.
Mirrors POST /admin/caep 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 |
|---|---|---|---|
session_id |
string | yes | The session. |
200: Confirmation, or a refusal naming the id.
| 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 |
GET /admin-api/caep/sessions
getCaepSessions
The CAEP session register, searched and paged — or one session with everything that has been said about it
What /admin/caep-sessions draws. Without session it is the register: one row per session this service has HELD, including the ones it no longer holds, with its CAEP state, assurance, device compliance, risk and a count per event type — searched with sessq and paged with sessionsPage and per. Beside it, applications: what this transmitter has said to each RECEIVER across every session, searched with appq and paged with applicationsPage. That is the third question this page answers and the one somebody arrives with once more than one receiver exists — the sessions are per SESSION, the streams are per STREAM, and this is per APPLICATION.
With session it is that one session opened out: the events actually sent about it, in order, with the jti and the stream each went out on and what the register noticed as it was applied, paged with eventsPage.
THE REGISTER OUTLIVES THE SESSION AND THAT IS THE POINT. The session store forgets one the moment it is signed out, so a row saying revoked is the only remaining evidence that it existed and was revoked — and it is why this is not the same list as GET /admin-api/sessions, which is what is LIVE.
A session that names nothing answers 200 with session: null rather than 404: this register is capped at caep.maxSessionsTracked and drops the oldest, so an old identifier coming back empty is an ordinary outcome and not a missing resource.
Mirrors GET /admin/caep-sessions on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
sessq |
query | string | Narrows the register to rows whose username, sub, session id, SSF subject or protocol contains this. |
|
session |
query | string | One session id. The reply is then that session and its events rather than the list. | |
sessionsPage |
query | integer | Which page of the register. Clamped, like every page parameter here. | |
appq |
query | string | Narrows the per-receiver list to rows whose application name, identifier or stream aud contains this. It deliberately does NOT match event types: a receiver that takes none of the eight is exactly the row somebody is looking for when they ask why nothing arrived. |
|
applicationsPage |
query | integer | Which page of the per-receiver list. It shares per with the register above it, which is the arrangement every page here that carries two lists has. |
|
streamsPage |
query | integer | Which page of the streams a CAEP event could go to. It shares per with the two lists above. |
|
eventsPage |
query | integer | Which page of ONE session’s events, with session. |
|
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 register, or one session and its events.
| Member | Type | Required | What it is |
|---|---|---|---|
applications |
list | ||
applications[].accounts |
integer | ||
applications[].acknowledged |
integer | ||
applications[].audiences |
list | ||
applications[].audiences[] |
string | ||
applications[].counts |
map | ||
applications[].counts.{key} |
number | ||
applications[].declared |
boolean | ||
applications[].delivered |
integer | ||
applications[].deliveries |
list | ||
applications[].deliveries[] |
string | ||
applications[].dn |
string | ||
applications[].enabled |
integer | ||
applications[].endpoints |
list | ||
applications[].endpoints[] |
string | ||
applications[].failed |
integer | ||
applications[].identifier |
string | ||
applications[].lastPushAt |
string, or number, or null | ||
applications[].lastPushError |
string, or null | ||
applications[].name |
string, or null | ||
applications[].queued |
integer | ||
applications[].receiverErrors |
integer | ||
applications[].registered |
boolean | ||
applications[].sessions |
integer | ||
applications[].streamCount |
integer | ||
applications[].streams |
list | ||
applications[].streams[] |
string | ||
applications[].takes |
list | ||
applications[].takes[] |
string | ||
applications[].total |
integer | ||
autoEmit |
boolean | ||
autoEmitActs |
list | ||
autoEmitActs[] |
string | ||
cap |
number | ||
catalogue |
list | ||
catalogue[].deprecated |
string | ||
catalogue[].family |
string | ||
catalogue[].members |
list | ||
catalogue[].members[].name |
string | ||
catalogue[].members[].required |
boolean, or string, or null | ||
catalogue[].members[].type |
string, or null | ||
catalogue[].members[].values |
list | ||
catalogue[].members[].values[] |
string | ||
catalogue[].members[].what |
string | ||
catalogue[].name |
string | ||
catalogue[].offered |
boolean | ||
catalogue[].required |
list | ||
catalogue[].required[] |
string | ||
catalogue[].short |
string | ||
catalogue[].subject |
boolean, or string, or null | ||
catalogue[].subjectFormats |
list | ||
catalogue[].subjectFormats[] |
string | ||
catalogue[].uri |
string | ||
catalogue[].what |
string | ||
enabled |
boolean | ||
eventTypes |
list | ||
eventTypes[].deprecated |
string | ||
eventTypes[].family |
string | ||
eventTypes[].members |
list | ||
eventTypes[].members[].name |
string | ||
eventTypes[].members[].required |
boolean, or string, or null | ||
eventTypes[].members[].type |
string, or null | ||
eventTypes[].members[].values |
list | ||
eventTypes[].members[].values[] |
string | ||
eventTypes[].members[].what |
string | ||
eventTypes[].name |
string | ||
eventTypes[].offered |
boolean | ||
eventTypes[].required |
list | ||
eventTypes[].required[] |
string | ||
eventTypes[].short |
string | ||
eventTypes[].subject |
boolean, or string, or null | ||
eventTypes[].subjectFormats |
list | ||
eventTypes[].subjectFormats[] |
string | ||
eventTypes[].uri |
string | ||
eventTypes[].what |
string | ||
events |
list | ||
events[].at |
string | ||
events[].jti |
string | ||
events[].name |
string | ||
events[].streamId |
string | ||
events[].uri |
string | ||
events[].warnings |
list | ||
events[].warnings[] |
string | ||
filter |
object | ||
filter.applications |
string, or null | ||
filter.sessions |
string, or null | ||
id |
string | ||
installed |
boolean | ||
issuer |
string | ||
matched |
object | ||
matched.applications |
integer | ||
matched.sessions |
integer | ||
matched.streams |
integer | ||
note |
string | ||
omitEventTimestamp |
boolean | ||
paging |
object | ||
paging.applications |
object | ||
paging.applications.firstRow |
integer | ||
paging.applications.lastRow |
integer | ||
paging.applications.noun |
string | ||
paging.applications.page |
integer | ||
paging.applications.pages |
integer | ||
paging.applications.param |
string | ||
paging.applications.perPage |
integer | ||
paging.applications.total |
integer | ||
paging.events |
object | ||
paging.events.firstRow |
integer | ||
paging.events.lastRow |
integer | ||
paging.events.noun |
string | ||
paging.events.page |
integer | ||
paging.events.pages |
integer | ||
paging.events.param |
string | ||
paging.events.perPage |
integer | ||
paging.events.total |
integer | ||
paging.sessions |
object | ||
paging.sessions.firstRow |
integer | ||
paging.sessions.lastRow |
integer | ||
paging.sessions.noun |
string | ||
paging.sessions.page |
integer | ||
paging.sessions.pages |
integer | ||
paging.sessions.param |
string | ||
paging.sessions.perPage |
integer | ||
paging.sessions.total |
integer | ||
paging.streams |
object | ||
paging.streams.firstRow |
integer | ||
paging.streams.lastRow |
integer | ||
paging.streams.noun |
string | ||
paging.streams.page |
integer | ||
paging.streams.pages |
integer | ||
paging.streams.param |
string | ||
paging.streams.perPage |
integer | ||
paging.streams.total |
integer | ||
session |
object | ||
session.acr |
string, or null | ||
session.amr |
list | ||
session.amr[] |
string | ||
session.assurance |
object | ||
session.assurance.level |
string | ||
session.assurance.namespace |
string | ||
session.assurance.previousLevel |
string | ||
session.claims |
any JSON | The claims a token-claims-change event said changed: whichever a person configured or an emitter named. The claims a token-claims-change event said changed: whichever a person configured or an emitter named. |
|
session.compliance |
string, or null | ||
session.counts |
map | ||
session.counts.{key} |
number | ||
session.credentials |
list | ||
session.credentials[].at |
string | ||
session.credentials[].changeType |
string | ||
session.credentials[].credentialType |
string | ||
session.credentials[].friendlyName |
string | ||
session.establishedAt |
string, or number, or null | ||
session.events |
list | ||
session.events[].at |
string | ||
session.events[].jti |
string | ||
session.events[].name |
string | ||
session.events[].streamId |
string | ||
session.events[].uri |
string | ||
session.events[].warnings |
list | ||
session.events[].warnings[] |
string | ||
session.iss |
string, or null | ||
session.notes |
list | ||
session.notes[] |
string | ||
session.protocol |
string, or null | ||
session.risk |
object | ||
session.risk.level |
string | ||
session.risk.previousLevel |
string | ||
session.risk.reason |
string | ||
session.sessionId |
string | ||
session.state |
string, or null | ||
session.streams |
list | ||
session.streams[] |
string | ||
session.sub |
string, or null | ||
session.subject |
string | ||
session.total |
integer | ||
session.updatedAt |
string, or number, or null | ||
session.username |
string, or null | ||
sessions |
list | ||
sessions[].acr |
string, or null | ||
sessions[].amr |
list | ||
sessions[].amr[] |
string | ||
sessions[].assurance |
object | ||
sessions[].assurance.level |
string | ||
sessions[].assurance.namespace |
string | ||
sessions[].assurance.previousLevel |
string | ||
sessions[].claims |
any JSON | The claims a token-claims-change event said changed: whichever a person configured or an emitter named. The claims a token-claims-change event said changed: whichever a person configured or an emitter named. |
|
sessions[].compliance |
string, or null | ||
sessions[].counts |
map | ||
sessions[].counts.{key} |
number | ||
sessions[].credentials |
list | ||
sessions[].credentials[].at |
string | ||
sessions[].credentials[].changeType |
string | ||
sessions[].credentials[].credentialType |
string | ||
sessions[].credentials[].friendlyName |
string | ||
sessions[].establishedAt |
string, or number, or null | ||
sessions[].events |
list | ||
sessions[].events[].at |
string | ||
sessions[].events[].jti |
string | ||
sessions[].events[].name |
string | ||
sessions[].events[].streamId |
string | ||
sessions[].events[].uri |
string | ||
sessions[].events[].warnings |
list | ||
sessions[].events[].warnings[] |
string | ||
sessions[].iss |
string, or null | ||
sessions[].notes |
list | ||
sessions[].notes[] |
string | ||
sessions[].protocol |
string, or null | ||
sessions[].risk |
object | ||
sessions[].risk.level |
string | ||
sessions[].risk.previousLevel |
string | ||
sessions[].risk.reason |
string | ||
sessions[].sessionId |
string | ||
sessions[].state |
string, or null | ||
sessions[].streams |
list | ||
sessions[].streams[] |
string | ||
sessions[].sub |
string, or null | ||
sessions[].subject |
string | ||
sessions[].total |
integer | ||
sessions[].updatedAt |
string, or number, or null | ||
sessions[].username |
string, or null | ||
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}[].label |
string | ||
settings.sharedWith.{key}[].path |
string | ||
shown |
object | ||
shown.applications |
list | ||
shown.applications[].accounts |
integer | ||
shown.applications[].acknowledged |
integer | ||
shown.applications[].audiences |
list | ||
shown.applications[].audiences[] |
string | ||
shown.applications[].counts |
map | ||
shown.applications[].counts.{key} |
number | ||
shown.applications[].declared |
boolean | ||
shown.applications[].delivered |
integer | ||
shown.applications[].deliveries |
list | ||
shown.applications[].deliveries[] |
string | ||
shown.applications[].dn |
string | ||
shown.applications[].enabled |
integer | ||
shown.applications[].endpoints |
list | ||
shown.applications[].endpoints[] |
string | ||
shown.applications[].failed |
integer | ||
shown.applications[].identifier |
string | ||
shown.applications[].lastPushAt |
string, or number, or null | ||
shown.applications[].lastPushError |
string, or null | ||
shown.applications[].name |
string, or null | ||
shown.applications[].queued |
integer | ||
shown.applications[].receiverErrors |
integer | ||
shown.applications[].registered |
boolean | ||
shown.applications[].sessions |
integer | ||
shown.applications[].streamCount |
integer | ||
shown.applications[].streams |
list | ||
shown.applications[].streams[] |
string | ||
shown.applications[].takes |
list | ||
shown.applications[].takes[] |
string | ||
shown.applications[].total |
integer | ||
shown.sessions |
list | ||
shown.sessions[].acr |
string, or null | ||
shown.sessions[].amr |
list | ||
shown.sessions[].amr[] |
string | ||
shown.sessions[].assurance |
object | ||
shown.sessions[].assurance.level |
string | ||
shown.sessions[].assurance.namespace |
string | ||
shown.sessions[].assurance.previousLevel |
string | ||
shown.sessions[].claims |
any JSON | The claims a token-claims-change event said changed: whichever a person configured or an emitter named. The claims a token-claims-change event said changed: whichever a person configured or an emitter named. |
|
shown.sessions[].compliance |
string, or null | ||
shown.sessions[].counts |
map | ||
shown.sessions[].counts.{key} |
number | ||
shown.sessions[].credentials |
list | ||
shown.sessions[].credentials[].at |
string | ||
shown.sessions[].credentials[].changeType |
string | ||
shown.sessions[].credentials[].credentialType |
string | ||
shown.sessions[].credentials[].friendlyName |
string | ||
shown.sessions[].establishedAt |
string, or number, or null | ||
shown.sessions[].events |
list | ||
shown.sessions[].events[].at |
string | ||
shown.sessions[].events[].jti |
string | ||
shown.sessions[].events[].name |
string | ||
shown.sessions[].events[].streamId |
string | ||
shown.sessions[].events[].uri |
string | ||
shown.sessions[].events[].warnings |
list | ||
shown.sessions[].events[].warnings[] |
string | ||
shown.sessions[].iss |
string, or null | ||
shown.sessions[].notes |
list | ||
shown.sessions[].notes[] |
string | ||
shown.sessions[].protocol |
string, or null | ||
shown.sessions[].risk |
object | ||
shown.sessions[].risk.level |
string | ||
shown.sessions[].risk.previousLevel |
string | ||
shown.sessions[].risk.reason |
string | ||
shown.sessions[].sessionId |
string | ||
shown.sessions[].state |
string, or null | ||
shown.sessions[].streams |
list | ||
shown.sessions[].streams[] |
string | ||
shown.sessions[].sub |
string, or null | ||
shown.sessions[].subject |
string | ||
shown.sessions[].total |
integer | ||
shown.sessions[].updatedAt |
string, or number, or null | ||
shown.sessions[].username |
string, or null | ||
shown.streams |
list | ||
shown.streams[].aud |
list, or string, or null | ||
shown.streams[].aud[] |
string | ||
shown.streams[].delivery |
string | ||
shown.streams[].status |
string | ||
shown.streams[].stream_id |
string | ||
shown.streams[].subjects |
integer | ||
shown.streams[].takes |
list | ||
shown.streams[].takes[] |
string | ||
ssfEnabled |
boolean | ||
streamCounts |
object | ||
streamCounts.taking |
integer | ||
streamCounts.total |
integer | ||
streams |
list | ||
streams[].aud |
list, or string, or null | ||
streams[].aud[] |
string | ||
streams[].delivery |
string | ||
streams[].status |
string | ||
streams[].stream_id |
string | ||
streams[].subjects |
integer | ||
streams[].takes |
list | ||
streams[].takes[] |
string | ||
totals |
map | ||
totals.{key} |
number | ||
tracked |
integer |