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/audit-export
getAuditExport
Where this realm’s audit events are delivered (#641)
Everything Monitoring → Audit export draws: each destination without its secrets, this process’s queue and delivery counters, and the page’s settings. Figures are this process. Each process delivers its own events.
Mirrors GET /admin/audit-export 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 destinations and this process’s counters.
| Member | Type | Required | What it is |
|---|---|---|---|
destinations |
list | ||
destinations[].ack |
string, or number, or boolean, or null | ||
destinations[].appName |
string | ||
destinations[].contentType |
string | ||
destinations[].cursorSeq |
number | ||
destinations[].delivered |
number | ||
destinations[].droppedGap |
number | ||
destinations[].enabled |
boolean | ||
destinations[].excludeAttributes |
string | ||
destinations[].facility |
number, or string | ||
destinations[].failedPermanent |
number | ||
destinations[].failingSince |
number | ||
destinations[].headerText |
string | ||
destinations[].headers |
map, or string | ||
destinations[].headers.{key} |
string | ||
destinations[].host |
string | ||
destinations[].id |
string | ||
destinations[].index |
string | ||
destinations[].lastDisposition |
string, or null | ||
destinations[].lastFailure |
string, or null | ||
destinations[].lastFailureAt |
number | ||
destinations[].lastSuccessAt |
number | ||
destinations[].latencyMs |
number | ||
destinations[].mode |
number, or string | ||
destinations[].name |
string | ||
destinations[].path |
string | ||
destinations[].pausedUntil |
number | ||
destinations[].port |
number, or string | ||
destinations[].primed |
boolean | ||
destinations[].queueDepth |
number | ||
destinations[].retries |
number | ||
destinations[].rotateBytes |
number | ||
destinations[].secretHeaderSet |
list | ||
destinations[].secretHeaderSet[] |
string | ||
destinations[].source |
string | ||
destinations[].sourcetype |
string | ||
destinations[].status |
string | ||
destinations[].template |
string | ||
destinations[].tokenSet |
boolean | ||
destinations[].transport |
string | ||
destinations[].type |
string | ||
destinations[].url |
string | ||
enabled |
boolean | ||
job |
object | ||
job.id |
string | ||
job.kind |
string | ||
job.scope |
string | ||
settings |
object | The settings this page draws, described: the same rows GET /config returns, filtered to the ones this page owns. | |
settings.context |
object | ||
settings.context.configFile |
string, or null | ||
settings.context.defaultsFile |
string | ||
settings.context.inRealm |
boolean | ||
settings.context.persistenceMode |
string | ||
settings.context.persistsAppconfig |
boolean | ||
settings.context.persistsRealms |
boolean | ||
settings.context.realmId |
string | ||
settings.editableCount |
integer | How many of them can be changed while the service runs. | |
settings.groups |
list | In the order config.js declares them. |
|
settings.groups[] |
object | One group’s settings. | |
settings.groups[].group |
string | ||
settings.groups[].settings |
list | ||
settings.groups[].settings[] |
object | One setting: what it is, what it is set to, and where that came from. | |
settings.groups[].settings[].appconfigPath |
string | ||
settings.groups[].settings[].csvValueNotes |
map | Present beside csvValues where the setting describes each value: the value mapped to one sentence. |
|
settings.groups[].settings[].csvValueNotes.{key} |
string | ||
settings.groups[].settings[].csvValues |
list | Present on a csv setting whose entries must each be one of these; absent on an open list. |
|
settings.groups[].settings[].csvValues[] |
string | ||
settings.groups[].settings[].default |
list, or string, or number, or boolean, or null | ||
settings.groups[].settings[].default[] |
string, or number, or boolean | ||
settings.groups[].settings[].description |
string | What it does and why the default is the default. | |
settings.groups[].settings[].editRefusal |
string | Why this row cannot be edited from the realm the reader is in: realms.maxCount while a realm other than the default is ambient. Absent on every row of the default realm’s answer. |
|
settings.groups[].settings[].editable |
boolean | Whether POST /config/set will take it from the realm this answer was read in. False means either the value was consumed at startup or editRefusal is set. It is refused rather than accepted, because an accepted change that does nothing reads as having worked. |
|
settings.groups[].settings[].enumValues |
list | Present on enum settings only. |
|
settings.groups[].settings[].enumValues[] |
string | ||
settings.groups[].settings[].env |
string | Its environment variable. | |
settings.groups[].settings[].group |
string | The protocol it belongs to, and the console’s section heading. | |
settings.groups[].settings[].key |
string | The dot path, which is BOTH the name every operation here takes and the path in the appconfig file. oid4vci.batchSize is appconfig.oid4vci.batchSize. |
|
settings.groups[].settings[].label |
string | ||
settings.groups[].settings[].masked |
boolean | Present, true, when a sensitive value here was replaced. | |
settings.groups[].settings[].max |
number | The highest value it will take. | |
settings.groups[].settings[].min |
number | The lowest value POST /config/set will take, on an int setting that declares one. | |
settings.groups[].settings[].ordered |
boolean | Present, true, on a csv setting whose order is a preference: the first value is the most preferred. |
|
settings.groups[].settings[].overridden |
boolean | Whether a runtime override is in force. Equal to source === "override", and reported separately so a caller can filter without matching a string. |
|
settings.groups[].settings[].realmSettable |
boolean | Whether a trust realm may hold its own value for it. | |
settings.groups[].settings[].restartReason |
string | Why it is not editable, when the value was consumed at startup. | |
settings.groups[].settings[].selectAll |
object | Present on an ordered setting whose select-all is narrowed by other settings. onlyWhileOn: the values are selected only while that setting is on. aloneWhileOn: while that setting is on, only the values are selected. canBeOn is false where this mode never lets that setting be on. |
|
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 |
one of realm, override, env, env-legacy, appconfig, defaults, default |
Where the effective value came from, highest first: this trust realm’s own value; a runtime override set through this API or the console; the setting’s own environment variable; a legacy variable (no row has one since #523); the appconfig file CONFIG_FILE names; env/defaults.js, the DEFAULT appconfig file that one is unioned on top of. default is reachable only for the DERIVED settings, whose value is a function of a neighbouring setting: for every other setting, no value anywhere stops this service from STARTING. |
|
settings.groups[].settings[].step |
number | The value must be a MULTIPLE of this, counted from min. The four token lifetimes use 30. |
|
settings.groups[].settings[].text |
string | The same value on one line: what the console shows in its input and what the environment variable would carry. | |
settings.groups[].settings[].type |
string | How a value posted for it is coerced and checked: one of config.js’s types (string, int, port, bool, csv, enum, color). |
|
settings.groups[].settings[].value |
list, or string, or number, or boolean, or null | ||
settings.groups[].settings[].value[] |
string, or number, or boolean | ||
settings.overridden |
list | The keys on this page with a runtime override in force. | |
settings.overridden[] |
string | ||
settings.page |
string | ||
settings.setWith |
string | The operation that writes them. | |
settings.settingCount |
integer | ||
settings.sharedWith |
map | A group drawn on another page as well, and those pages. | |
settings.sharedWith.{key} |
list | ||
settings.sharedWith.{key}[].label |
string, or null | ||
settings.sharedWith.{key}[].path |
string | ||
stats |
object | ||
stats.availability |
number | ||
stats.awaiting |
number | ||
stats.delivered |
number | ||
stats.dropped |
number | ||
stats.generated |
number | ||
stats.latencyMs |
number | ||
stats.permanentlyFailed |
number | ||
stats.retrying |
number | ||
thisProcess |
boolean |
POST /admin-api/audit-export/add
addAuditExportDestination
Add an audit export destination
Creates a destination. A secret that will not seal is refused. A private address, a cloud metadata address, a URL with user information, and a filesystem path outside the allowed roots are refused. Audited, without the address or the secret.
Mirrors POST /admin/audit-export 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 |
|---|---|---|---|
ack |
boolean | Splunk HEC: wait for the indexer ack before the cursor moves. One event is in flight. | |
appName |
string | syslog and logrhythm: the APP-NAME. iya-sts when empty. | |
contentType |
string | webhook: the content type. Empty is JSON, or text when a template is set. | |
enabled |
boolean | Whether the job delivers to it. | |
excludeAttributes |
string | More detail names to remove, separated by commas. | |
facility |
integer | syslog and logrhythm. 16 is local0. | |
headers |
string | webhook: plain headers, one “Name: value” a line. Sent back on a change. Empty replaces them. A name that looks like a credential is sealed instead. | |
host |
string | syslog and logrhythm: the host. | |
id |
string | yes | The destination id. A letter or a digit, then lower-case letters, digits and hyphens. It does not change. |
index |
string | Splunk HEC: the index. Empty uses the token’s. | |
mode |
string | file: three octal digits, such as 640. | |
name |
string | What to call it on the page. | |
path |
string | file: an absolute path. | |
port |
integer | syslog and logrhythm: the port. 0 or omitted is 6514 for TLS and 514 otherwise. | |
rotateBytes |
integer | file: rotate at this size. 0 is off. | |
secretHeaders |
string | webhook: sealed headers, one “Name: value” a line. Never returned. Empty keeps every one. A blank value keeps that one name. | |
source |
string | Splunk HEC: the source. iya-sts when empty. | |
sourcetype |
string | Splunk HEC: the sourcetype. iya:audit when empty. | |
template |
string | webhook: one line with {timestamp} and the other placeholders. Empty sends the canonical event as JSON. | |
token |
string | Splunk HEC: the collector token. Never returned. Empty on a change keeps it. | |
transport |
one of tcp, udp, tls |
syslog and logrhythm. TCP when omitted. UDP is fire-and-forget. | |
type |
one of syslog, file, webhook, splunk, logrhythm |
yes | syslog, file, webhook, splunk, or logrhythm. LogRhythm is the syslog adapter. |
url |
string | webhook or Splunk HEC: an https URL. |
200: The destination, without its secrets.
| Member | Type | Required | What it is |
|---|---|---|---|
destination |
object | ||
destination.ack |
string, or number, or boolean, or null | ||
destination.appName |
string | ||
destination.contentType |
string | ||
destination.cursorSeq |
number | ||
destination.delivered |
number | ||
destination.droppedGap |
number | ||
destination.enabled |
boolean | ||
destination.excludeAttributes |
string | ||
destination.facility |
number, or string | ||
destination.failedPermanent |
number | ||
destination.failingSince |
number | ||
destination.headerText |
string | ||
destination.headers |
map, or string | ||
destination.headers.{key} |
string | ||
destination.host |
string | ||
destination.id |
string | ||
destination.index |
string | ||
destination.lastDisposition |
string, or null | ||
destination.lastFailure |
string, or null | ||
destination.lastFailureAt |
number | ||
destination.lastSuccessAt |
number | ||
destination.latencyMs |
number | ||
destination.mode |
number, or string | ||
destination.name |
string | ||
destination.path |
string | ||
destination.pausedUntil |
number | ||
destination.port |
number, or string | ||
destination.primed |
boolean | ||
destination.queueDepth |
number | ||
destination.retries |
number | ||
destination.rotateBytes |
number | ||
destination.secretHeaderSet |
list | ||
destination.secretHeaderSet[] |
string | ||
destination.source |
string | ||
destination.sourcetype |
string | ||
destination.status |
string | ||
destination.template |
string | ||
destination.tokenSet |
boolean | ||
destination.transport |
string | ||
destination.type |
string | ||
destination.url |
string | ||
diagnostic |
object | ||
diagnostic.disposition |
string, or null | ||
diagnostic.test |
boolean | ||
error |
string | ||
error_description |
string | ||
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 |
|---|---|---|---|
destination |
object | ||
destination.ack |
string, or number, or boolean, or null | ||
destination.appName |
string | ||
destination.contentType |
string | ||
destination.cursorSeq |
number | ||
destination.delivered |
number | ||
destination.droppedGap |
number | ||
destination.enabled |
boolean | ||
destination.excludeAttributes |
string | ||
destination.facility |
number, or string | ||
destination.failedPermanent |
number | ||
destination.failingSince |
number | ||
destination.headerText |
string | ||
destination.headers |
map, or string | ||
destination.headers.{key} |
string | ||
destination.host |
string | ||
destination.id |
string | ||
destination.index |
string | ||
destination.lastDisposition |
string, or null | ||
destination.lastFailure |
string, or null | ||
destination.lastFailureAt |
number | ||
destination.lastSuccessAt |
number | ||
destination.latencyMs |
number | ||
destination.mode |
number, or string | ||
destination.name |
string | ||
destination.path |
string | ||
destination.pausedUntil |
number | ||
destination.port |
number, or string | ||
destination.primed |
boolean | ||
destination.queueDepth |
number | ||
destination.retries |
number | ||
destination.rotateBytes |
number | ||
destination.secretHeaderSet |
list | ||
destination.secretHeaderSet[] |
string | ||
destination.source |
string | ||
destination.sourcetype |
string | ||
destination.status |
string | ||
destination.template |
string | ||
destination.tokenSet |
boolean | ||
destination.transport |
string | ||
destination.type |
string | ||
destination.url |
string | ||
diagnostic |
object | ||
diagnostic.disposition |
string, or null | ||
diagnostic.test |
boolean | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/audit-export/disable
disableAuditExportDestination
Disable an audit export destination
The job stops visiting it and keeps the cursor. Audited.
Mirrors POST /admin/audit-export 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 |
|---|---|---|---|
id |
string | yes | The destination id. A letter or a digit, then lower-case letters, digits and hyphens. It does not change. |
200: The destination.
| Member | Type | Required | What it is |
|---|---|---|---|
destination |
object | ||
destination.ack |
string, or number, or boolean, or null | ||
destination.appName |
string | ||
destination.contentType |
string | ||
destination.cursorSeq |
number | ||
destination.delivered |
number | ||
destination.droppedGap |
number | ||
destination.enabled |
boolean | ||
destination.excludeAttributes |
string | ||
destination.facility |
number, or string | ||
destination.failedPermanent |
number | ||
destination.failingSince |
number | ||
destination.headerText |
string | ||
destination.headers |
map, or string | ||
destination.headers.{key} |
string | ||
destination.host |
string | ||
destination.id |
string | ||
destination.index |
string | ||
destination.lastDisposition |
string, or null | ||
destination.lastFailure |
string, or null | ||
destination.lastFailureAt |
number | ||
destination.lastSuccessAt |
number | ||
destination.latencyMs |
number | ||
destination.mode |
number, or string | ||
destination.name |
string | ||
destination.path |
string | ||
destination.pausedUntil |
number | ||
destination.port |
number, or string | ||
destination.primed |
boolean | ||
destination.queueDepth |
number | ||
destination.retries |
number | ||
destination.rotateBytes |
number | ||
destination.secretHeaderSet |
list | ||
destination.secretHeaderSet[] |
string | ||
destination.source |
string | ||
destination.sourcetype |
string | ||
destination.status |
string | ||
destination.template |
string | ||
destination.tokenSet |
boolean | ||
destination.transport |
string | ||
destination.type |
string | ||
destination.url |
string | ||
diagnostic |
object | ||
diagnostic.disposition |
string, or null | ||
diagnostic.test |
boolean | ||
error |
string | ||
error_description |
string | ||
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 |
|---|---|---|---|
destination |
object | ||
destination.ack |
string, or number, or boolean, or null | ||
destination.appName |
string | ||
destination.contentType |
string | ||
destination.cursorSeq |
number | ||
destination.delivered |
number | ||
destination.droppedGap |
number | ||
destination.enabled |
boolean | ||
destination.excludeAttributes |
string | ||
destination.facility |
number, or string | ||
destination.failedPermanent |
number | ||
destination.failingSince |
number | ||
destination.headerText |
string | ||
destination.headers |
map, or string | ||
destination.headers.{key} |
string | ||
destination.host |
string | ||
destination.id |
string | ||
destination.index |
string | ||
destination.lastDisposition |
string, or null | ||
destination.lastFailure |
string, or null | ||
destination.lastFailureAt |
number | ||
destination.lastSuccessAt |
number | ||
destination.latencyMs |
number | ||
destination.mode |
number, or string | ||
destination.name |
string | ||
destination.path |
string | ||
destination.pausedUntil |
number | ||
destination.port |
number, or string | ||
destination.primed |
boolean | ||
destination.queueDepth |
number | ||
destination.retries |
number | ||
destination.rotateBytes |
number | ||
destination.secretHeaderSet |
list | ||
destination.secretHeaderSet[] |
string | ||
destination.source |
string | ||
destination.sourcetype |
string | ||
destination.status |
string | ||
destination.template |
string | ||
destination.tokenSet |
boolean | ||
destination.transport |
string | ||
destination.type |
string | ||
destination.url |
string | ||
diagnostic |
object | ||
diagnostic.disposition |
string, or null | ||
diagnostic.test |
boolean | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/audit-export/enable
enableAuditExportDestination
Enable an audit export destination
The next run delivers to it. A destination that was never enabled is backfilled from the ring this process still holds. One that was disabled continues from its cursor. Audited.
Mirrors POST /admin/audit-export 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 |
|---|---|---|---|
id |
string | yes | The destination id. A letter or a digit, then lower-case letters, digits and hyphens. It does not change. |
200: The destination.
| Member | Type | Required | What it is |
|---|---|---|---|
destination |
object | ||
destination.ack |
string, or number, or boolean, or null | ||
destination.appName |
string | ||
destination.contentType |
string | ||
destination.cursorSeq |
number | ||
destination.delivered |
number | ||
destination.droppedGap |
number | ||
destination.enabled |
boolean | ||
destination.excludeAttributes |
string | ||
destination.facility |
number, or string | ||
destination.failedPermanent |
number | ||
destination.failingSince |
number | ||
destination.headerText |
string | ||
destination.headers |
map, or string | ||
destination.headers.{key} |
string | ||
destination.host |
string | ||
destination.id |
string | ||
destination.index |
string | ||
destination.lastDisposition |
string, or null | ||
destination.lastFailure |
string, or null | ||
destination.lastFailureAt |
number | ||
destination.lastSuccessAt |
number | ||
destination.latencyMs |
number | ||
destination.mode |
number, or string | ||
destination.name |
string | ||
destination.path |
string | ||
destination.pausedUntil |
number | ||
destination.port |
number, or string | ||
destination.primed |
boolean | ||
destination.queueDepth |
number | ||
destination.retries |
number | ||
destination.rotateBytes |
number | ||
destination.secretHeaderSet |
list | ||
destination.secretHeaderSet[] |
string | ||
destination.source |
string | ||
destination.sourcetype |
string | ||
destination.status |
string | ||
destination.template |
string | ||
destination.tokenSet |
boolean | ||
destination.transport |
string | ||
destination.type |
string | ||
destination.url |
string | ||
diagnostic |
object | ||
diagnostic.disposition |
string, or null | ||
diagnostic.test |
boolean | ||
error |
string | ||
error_description |
string | ||
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 |
|---|---|---|---|
destination |
object | ||
destination.ack |
string, or number, or boolean, or null | ||
destination.appName |
string | ||
destination.contentType |
string | ||
destination.cursorSeq |
number | ||
destination.delivered |
number | ||
destination.droppedGap |
number | ||
destination.enabled |
boolean | ||
destination.excludeAttributes |
string | ||
destination.facility |
number, or string | ||
destination.failedPermanent |
number | ||
destination.failingSince |
number | ||
destination.headerText |
string | ||
destination.headers |
map, or string | ||
destination.headers.{key} |
string | ||
destination.host |
string | ||
destination.id |
string | ||
destination.index |
string | ||
destination.lastDisposition |
string, or null | ||
destination.lastFailure |
string, or null | ||
destination.lastFailureAt |
number | ||
destination.lastSuccessAt |
number | ||
destination.latencyMs |
number | ||
destination.mode |
number, or string | ||
destination.name |
string | ||
destination.path |
string | ||
destination.pausedUntil |
number | ||
destination.port |
number, or string | ||
destination.primed |
boolean | ||
destination.queueDepth |
number | ||
destination.retries |
number | ||
destination.rotateBytes |
number | ||
destination.secretHeaderSet |
list | ||
destination.secretHeaderSet[] |
string | ||
destination.source |
string | ||
destination.sourcetype |
string | ||
destination.status |
string | ||
destination.template |
string | ||
destination.tokenSet |
boolean | ||
destination.transport |
string | ||
destination.type |
string | ||
destination.url |
string | ||
diagnostic |
object | ||
diagnostic.disposition |
string, or null | ||
diagnostic.test |
boolean | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/audit-export/remove
removeAuditExportDestination
Remove an audit export destination
Deletes the destination and this process’s cursor. Audited.
Mirrors POST /admin/audit-export 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 |
|---|---|---|---|
id |
string | yes | The destination id. A letter or a digit, then lower-case letters, digits and hyphens. It does not change. |
200: What was removed.
| Member | Type | Required | What it is |
|---|---|---|---|
destination |
object | ||
destination.ack |
string, or number, or boolean, or null | ||
destination.appName |
string | ||
destination.contentType |
string | ||
destination.cursorSeq |
number | ||
destination.delivered |
number | ||
destination.droppedGap |
number | ||
destination.enabled |
boolean | ||
destination.excludeAttributes |
string | ||
destination.facility |
number, or string | ||
destination.failedPermanent |
number | ||
destination.failingSince |
number | ||
destination.headerText |
string | ||
destination.headers |
map, or string | ||
destination.headers.{key} |
string | ||
destination.host |
string | ||
destination.id |
string | ||
destination.index |
string | ||
destination.lastDisposition |
string, or null | ||
destination.lastFailure |
string, or null | ||
destination.lastFailureAt |
number | ||
destination.lastSuccessAt |
number | ||
destination.latencyMs |
number | ||
destination.mode |
number, or string | ||
destination.name |
string | ||
destination.path |
string | ||
destination.pausedUntil |
number | ||
destination.port |
number, or string | ||
destination.primed |
boolean | ||
destination.queueDepth |
number | ||
destination.retries |
number | ||
destination.rotateBytes |
number | ||
destination.secretHeaderSet |
list | ||
destination.secretHeaderSet[] |
string | ||
destination.source |
string | ||
destination.sourcetype |
string | ||
destination.status |
string | ||
destination.template |
string | ||
destination.tokenSet |
boolean | ||
destination.transport |
string | ||
destination.type |
string | ||
destination.url |
string | ||
diagnostic |
object | ||
diagnostic.disposition |
string, or null | ||
diagnostic.test |
boolean | ||
error |
string | ||
error_description |
string | ||
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 |
|---|---|---|---|
destination |
object | ||
destination.ack |
string, or number, or boolean, or null | ||
destination.appName |
string | ||
destination.contentType |
string | ||
destination.cursorSeq |
number | ||
destination.delivered |
number | ||
destination.droppedGap |
number | ||
destination.enabled |
boolean | ||
destination.excludeAttributes |
string | ||
destination.facility |
number, or string | ||
destination.failedPermanent |
number | ||
destination.failingSince |
number | ||
destination.headerText |
string | ||
destination.headers |
map, or string | ||
destination.headers.{key} |
string | ||
destination.host |
string | ||
destination.id |
string | ||
destination.index |
string | ||
destination.lastDisposition |
string, or null | ||
destination.lastFailure |
string, or null | ||
destination.lastFailureAt |
number | ||
destination.lastSuccessAt |
number | ||
destination.latencyMs |
number | ||
destination.mode |
number, or string | ||
destination.name |
string | ||
destination.path |
string | ||
destination.pausedUntil |
number | ||
destination.port |
number, or string | ||
destination.primed |
boolean | ||
destination.queueDepth |
number | ||
destination.retries |
number | ||
destination.rotateBytes |
number | ||
destination.secretHeaderSet |
list | ||
destination.secretHeaderSet[] |
string | ||
destination.source |
string | ||
destination.sourcetype |
string | ||
destination.status |
string | ||
destination.template |
string | ||
destination.tokenSet |
boolean | ||
destination.transport |
string | ||
destination.type |
string | ||
destination.url |
string | ||
diagnostic |
object | ||
diagnostic.disposition |
string, or null | ||
diagnostic.test |
boolean | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/audit-export/test
testAuditExportDestination
Send a synthetic audit export event
Validates the destination and sends one synthetic event. That event is not an audit row. The administrative test is. The delivery cursor does not move.
Mirrors POST /admin/audit-export 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 |
|---|---|---|---|
id |
string | yes | The destination id. A letter or a digit, then lower-case letters, digits and hyphens. It does not change. |
200: diagnostic.disposition and test.
| Member | Type | Required | What it is |
|---|---|---|---|
destination |
object | ||
destination.ack |
string, or number, or boolean, or null | ||
destination.appName |
string | ||
destination.contentType |
string | ||
destination.cursorSeq |
number | ||
destination.delivered |
number | ||
destination.droppedGap |
number | ||
destination.enabled |
boolean | ||
destination.excludeAttributes |
string | ||
destination.facility |
number, or string | ||
destination.failedPermanent |
number | ||
destination.failingSince |
number | ||
destination.headerText |
string | ||
destination.headers |
map, or string | ||
destination.headers.{key} |
string | ||
destination.host |
string | ||
destination.id |
string | ||
destination.index |
string | ||
destination.lastDisposition |
string, or null | ||
destination.lastFailure |
string, or null | ||
destination.lastFailureAt |
number | ||
destination.lastSuccessAt |
number | ||
destination.latencyMs |
number | ||
destination.mode |
number, or string | ||
destination.name |
string | ||
destination.path |
string | ||
destination.pausedUntil |
number | ||
destination.port |
number, or string | ||
destination.primed |
boolean | ||
destination.queueDepth |
number | ||
destination.retries |
number | ||
destination.rotateBytes |
number | ||
destination.secretHeaderSet |
list | ||
destination.secretHeaderSet[] |
string | ||
destination.source |
string | ||
destination.sourcetype |
string | ||
destination.status |
string | ||
destination.template |
string | ||
destination.tokenSet |
boolean | ||
destination.transport |
string | ||
destination.type |
string | ||
destination.url |
string | ||
diagnostic |
object | ||
diagnostic.disposition |
string, or null | ||
diagnostic.test |
boolean | ||
error |
string | ||
error_description |
string | ||
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 |
|---|---|---|---|
destination |
object | ||
destination.ack |
string, or number, or boolean, or null | ||
destination.appName |
string | ||
destination.contentType |
string | ||
destination.cursorSeq |
number | ||
destination.delivered |
number | ||
destination.droppedGap |
number | ||
destination.enabled |
boolean | ||
destination.excludeAttributes |
string | ||
destination.facility |
number, or string | ||
destination.failedPermanent |
number | ||
destination.failingSince |
number | ||
destination.headerText |
string | ||
destination.headers |
map, or string | ||
destination.headers.{key} |
string | ||
destination.host |
string | ||
destination.id |
string | ||
destination.index |
string | ||
destination.lastDisposition |
string, or null | ||
destination.lastFailure |
string, or null | ||
destination.lastFailureAt |
number | ||
destination.lastSuccessAt |
number | ||
destination.latencyMs |
number | ||
destination.mode |
number, or string | ||
destination.name |
string | ||
destination.path |
string | ||
destination.pausedUntil |
number | ||
destination.port |
number, or string | ||
destination.primed |
boolean | ||
destination.queueDepth |
number | ||
destination.retries |
number | ||
destination.rotateBytes |
number | ||
destination.secretHeaderSet |
list | ||
destination.secretHeaderSet[] |
string | ||
destination.source |
string | ||
destination.sourcetype |
string | ||
destination.status |
string | ||
destination.template |
string | ||
destination.tokenSet |
boolean | ||
destination.transport |
string | ||
destination.type |
string | ||
destination.url |
string | ||
diagnostic |
object | ||
diagnostic.disposition |
string, or null | ||
diagnostic.test |
boolean | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/audit-export/update
updateAuditExportDestination
Change an audit export destination
The members given replace the destination’s. An empty token or secret header keeps the stored one. Plain headers, including empty, replace. Checked as add is. Audited, without the address or the secret.
Mirrors POST /admin/audit-export 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 |
|---|---|---|---|
ack |
boolean | Splunk HEC: wait for the indexer ack before the cursor moves. One event is in flight. | |
appName |
string | syslog and logrhythm: the APP-NAME. iya-sts when empty. | |
contentType |
string | webhook: the content type. Empty is JSON, or text when a template is set. | |
enabled |
boolean | Whether the job delivers to it. | |
excludeAttributes |
string | More detail names to remove, separated by commas. | |
facility |
integer | syslog and logrhythm. 16 is local0. | |
headers |
string | webhook: plain headers, one “Name: value” a line. Sent back on a change. Empty replaces them. A name that looks like a credential is sealed instead. | |
host |
string | syslog and logrhythm: the host. | |
id |
string | yes | The destination id. A letter or a digit, then lower-case letters, digits and hyphens. It does not change. |
index |
string | Splunk HEC: the index. Empty uses the token’s. | |
mode |
string | file: three octal digits, such as 640. | |
name |
string | What to call it on the page. | |
path |
string | file: an absolute path. | |
port |
integer | syslog and logrhythm: the port. 0 or omitted is 6514 for TLS and 514 otherwise. | |
rotateBytes |
integer | file: rotate at this size. 0 is off. | |
secretHeaders |
string | webhook: sealed headers, one “Name: value” a line. Never returned. Empty keeps every one. A blank value keeps that one name. | |
source |
string | Splunk HEC: the source. iya-sts when empty. | |
sourcetype |
string | Splunk HEC: the sourcetype. iya:audit when empty. | |
template |
string | webhook: one line with {timestamp} and the other placeholders. Empty sends the canonical event as JSON. | |
token |
string | Splunk HEC: the collector token. Never returned. Empty on a change keeps it. | |
transport |
one of tcp, udp, tls |
syslog and logrhythm. TCP when omitted. UDP is fire-and-forget. | |
type |
one of syslog, file, webhook, splunk, logrhythm |
syslog, file, webhook, splunk, or logrhythm. LogRhythm is the syslog adapter. | |
url |
string | webhook or Splunk HEC: an https URL. |
200: The destination, without its secrets.
| Member | Type | Required | What it is |
|---|---|---|---|
destination |
object | ||
destination.ack |
string, or number, or boolean, or null | ||
destination.appName |
string | ||
destination.contentType |
string | ||
destination.cursorSeq |
number | ||
destination.delivered |
number | ||
destination.droppedGap |
number | ||
destination.enabled |
boolean | ||
destination.excludeAttributes |
string | ||
destination.facility |
number, or string | ||
destination.failedPermanent |
number | ||
destination.failingSince |
number | ||
destination.headerText |
string | ||
destination.headers |
map, or string | ||
destination.headers.{key} |
string | ||
destination.host |
string | ||
destination.id |
string | ||
destination.index |
string | ||
destination.lastDisposition |
string, or null | ||
destination.lastFailure |
string, or null | ||
destination.lastFailureAt |
number | ||
destination.lastSuccessAt |
number | ||
destination.latencyMs |
number | ||
destination.mode |
number, or string | ||
destination.name |
string | ||
destination.path |
string | ||
destination.pausedUntil |
number | ||
destination.port |
number, or string | ||
destination.primed |
boolean | ||
destination.queueDepth |
number | ||
destination.retries |
number | ||
destination.rotateBytes |
number | ||
destination.secretHeaderSet |
list | ||
destination.secretHeaderSet[] |
string | ||
destination.source |
string | ||
destination.sourcetype |
string | ||
destination.status |
string | ||
destination.template |
string | ||
destination.tokenSet |
boolean | ||
destination.transport |
string | ||
destination.type |
string | ||
destination.url |
string | ||
diagnostic |
object | ||
diagnostic.disposition |
string, or null | ||
diagnostic.test |
boolean | ||
error |
string | ||
error_description |
string | ||
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 |
|---|---|---|---|
destination |
object | ||
destination.ack |
string, or number, or boolean, or null | ||
destination.appName |
string | ||
destination.contentType |
string | ||
destination.cursorSeq |
number | ||
destination.delivered |
number | ||
destination.droppedGap |
number | ||
destination.enabled |
boolean | ||
destination.excludeAttributes |
string | ||
destination.facility |
number, or string | ||
destination.failedPermanent |
number | ||
destination.failingSince |
number | ||
destination.headerText |
string | ||
destination.headers |
map, or string | ||
destination.headers.{key} |
string | ||
destination.host |
string | ||
destination.id |
string | ||
destination.index |
string | ||
destination.lastDisposition |
string, or null | ||
destination.lastFailure |
string, or null | ||
destination.lastFailureAt |
number | ||
destination.lastSuccessAt |
number | ||
destination.latencyMs |
number | ||
destination.mode |
number, or string | ||
destination.name |
string | ||
destination.path |
string | ||
destination.pausedUntil |
number | ||
destination.port |
number, or string | ||
destination.primed |
boolean | ||
destination.queueDepth |
number | ||
destination.retries |
number | ||
destination.rotateBytes |
number | ||
destination.secretHeaderSet |
list | ||
destination.secretHeaderSet[] |
string | ||
destination.source |
string | ||
destination.sourcetype |
string | ||
destination.status |
string | ||
destination.template |
string | ||
destination.tokenSet |
boolean | ||
destination.transport |
string | ||
destination.type |
string | ||
destination.url |
string | ||
diagnostic |
object | ||
diagnostic.disposition |
string, or null | ||
diagnostic.test |
boolean | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
GET /admin-api/deliveries
getOutboundDeliveries
Every outbound delivery on the shared queue, by kind
What /admin/deliveries draws: for each kind — backchannel-logout, ciba and provider-commands — its counts by state and its rows, newest first. state (pending, sent, dead), kind and q narrow. Never a token or a body.
Mirrors GET /admin/deliveries on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
state |
query | string | Only deliveries in this state: pending, sent or dead; empty for every state. | |
kind |
query | string | Only this kind. | |
q |
query | string | Narrows the deliveries. | |
per |
query | integer | Rows per page of each kind, capped. | |
backchannelLogoutPage |
query | integer | Which page of one kind’s rows; each kind moves on its own parameter, its paging.param. |
|
cibaPage |
query | integer | Which page of one kind’s rows; each kind moves on its own parameter, its paging.param. |
|
cellOpsPage |
query | integer | Which page of one kind’s rows; each kind moves on its own parameter, its paging.param. |
|
providerCommandsPage |
query | integer | Which page of one kind’s rows; each kind moves on its own parameter, its paging.param. |
|
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 kinds.
| Member | Type | Required | What it is |
|---|---|---|---|
kinds |
list | ||
kinds[].counts |
object | ||
kinds[].counts.dead |
integer | ||
kinds[].counts.pending |
integer | ||
kinds[].counts.sent |
integer | ||
kinds[].id |
string | ||
kinds[].matched |
integer | ||
kinds[].page |
string | ||
kinds[].paging |
object | Which page of how many, and the query parameter that moves it. | |
kinds[].paging.firstRow |
integer | ||
kinds[].paging.lastRow |
integer | ||
kinds[].paging.noun |
string | ||
kinds[].paging.page |
integer | ||
kinds[].paging.pages |
integer | ||
kinds[].paging.param |
string | ||
kinds[].paging.perPage |
integer | ||
kinds[].paging.total |
integer | ||
kinds[].rows |
list | ||
kinds[].rows[].accountState |
string, or null | ||
kinds[].rows[].attempts |
number | ||
kinds[].rows[].authReqId |
string, or null | ||
kinds[].rows[].awaitingCallback |
boolean | ||
kinds[].rows[].body |
any JSON | What an inter-cell operation carries, which is that operation’s own request. What an inter-cell operation carries, which is that operation’s own request. | |
kinds[].rows[].bodyDigest |
string, or null | ||
kinds[].rows[].cell |
string, or null | ||
kinds[].rows[].clientId |
string, or null | ||
kinds[].rows[].command |
string, or null | ||
kinds[].rows[].encrypted |
string, or null | ||
kinds[].rows[].errorCode |
string, or null | ||
kinds[].rows[].fenceAt |
number | ||
kinds[].rows[].finishedAt |
string, or number | ||
kinds[].rows[].generation |
number | ||
kinds[].rows[].holder |
string | ||
kinds[].rows[].id |
string | ||
kinds[].rows[].inFlight |
boolean, or number | ||
kinds[].rows[].iss |
string, or null | ||
kinds[].rows[].lastAttemptAt |
string, or number | ||
kinds[].rows[].mode |
string, or null | ||
kinds[].rows[].nextAttemptAt |
string, or number | ||
kinds[].rows[].op |
string, or null | ||
kinds[].rows[].queuedAt |
string, or number | ||
kinds[].rows[].realm |
string | ||
kinds[].rows[].sessionId |
string, or null | ||
kinds[].rows[].sessionRequired |
boolean | ||
kinds[].rows[].sid |
string, or null | ||
kinds[].rows[].state |
string | ||
kinds[].rows[].status |
string, or number, or boolean, or null | ||
kinds[].rows[].sub |
string, or null | ||
kinds[].rows[].tokenDigest |
string, or null | ||
kinds[].rows[].trigger |
string, or null | ||
kinds[].rows[].updatedAt |
number | ||
kinds[].rows[].uri |
string, or null | ||
kinds[].rows[].username |
string, or null | ||
kinds[].rows[].via |
string, or null | ||
kinds[].rows[].why |
string, or null | ||
kinds[].title |
string | ||
states |
list | ||
states[] |
string |
POST /admin-api/deliveries/retry
retryOutboundDelivery
Retry a dead letter of any kind
A new generation of the delivery: a fresh attempt budget and the client’s current address. Audited by its kind.
Mirrors POST /admin/deliveries 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 | |
kind |
one of backchannel-logout, ciba, provider-commands |
yes |
200: The delivery queued again.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
row |
object | ||
row.accountState |
string, or null | ||
row.attempts |
number | ||
row.authReqId |
string, or null | ||
row.awaitingCallback |
boolean | ||
row.body |
any JSON | What an inter-cell operation carries, which is that operation’s own request. What an inter-cell operation carries, which is that operation’s own request. | |
row.bodyDigest |
string, or null | ||
row.cell |
string, or null | ||
row.clientId |
string, or null | ||
row.command |
string, or null | ||
row.encrypted |
string, or null | ||
row.fenceAt |
number | ||
row.finishedAt |
string, or number | ||
row.generation |
number | ||
row.holder |
string | ||
row.id |
string | ||
row.inFlight |
boolean, or number | ||
row.iss |
string, or null | ||
row.lastAttemptAt |
string, or number | ||
row.mode |
string, or null | ||
row.nextAttemptAt |
string, or number | ||
row.op |
string, or null | ||
row.queuedAt |
string, or number | ||
row.realm |
string | ||
row.sessionId |
string, or null | ||
row.sessionRequired |
boolean | ||
row.sid |
string, or null | ||
row.state |
string | ||
row.status |
string, or number, or boolean, or null | ||
row.sub |
string, or null | ||
row.tokenDigest |
string, or null | ||
row.trigger |
string, or null | ||
row.updatedAt |
number | ||
row.uri |
string, or null | ||
row.username |
string, or null | ||
row.via |
string, or null | ||
row.why |
string, or null |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
row |
object | ||
row.accountState |
string, or null | ||
row.attempts |
number | ||
row.authReqId |
string, or null | ||
row.awaitingCallback |
boolean | ||
row.body |
any JSON | What an inter-cell operation carries, which is that operation’s own request. What an inter-cell operation carries, which is that operation’s own request. | |
row.bodyDigest |
string, or null | ||
row.cell |
string, or null | ||
row.clientId |
string, or null | ||
row.command |
string, or null | ||
row.encrypted |
string, or null | ||
row.fenceAt |
number | ||
row.finishedAt |
string, or number | ||
row.generation |
number | ||
row.holder |
string | ||
row.id |
string | ||
row.inFlight |
boolean, or number | ||
row.iss |
string, or null | ||
row.lastAttemptAt |
string, or number | ||
row.mode |
string, or null | ||
row.nextAttemptAt |
string, or number | ||
row.op |
string, or null | ||
row.queuedAt |
string, or number | ||
row.realm |
string | ||
row.sessionId |
string, or null | ||
row.sessionRequired |
boolean | ||
row.sid |
string, or null | ||
row.state |
string | ||
row.status |
string, or number, or boolean, or null | ||
row.sub |
string, or null | ||
row.tokenDigest |
string, or null | ||
row.trigger |
string, or null | ||
row.updatedAt |
number | ||
row.uri |
string, or null | ||
row.username |
string, or null | ||
row.via |
string, or null | ||
row.why |
string, or null |
GET /admin-api/passkey-report
getPasskeyReport
Who holds which passkey algorithm, across the realm (#942)
Everything Monitoring → Passkeys draws. people: total, holding, postQuantumOnly, classicalOnly, both, none and withPostQuantum — a person’s kind is the ALGORITHM of their keys (ML-DSA is post-quantum), never the lane. keys: total, postQuantum, classical, byLane and byAlgorithm (each algorithm, coseAlg, lane, postQuantum, count). models: each AAGUID with its name and the algorithms its keys use. attestation: the leaf certificate’s signature algorithm (#941). recorded is false when no counted passkey stored one. profiles: each passkey profile’s postQuantumRequired and selectors. counted: where the numbers came from — the recount’s baseline (when, how long, how many holders) plus the changesSince noted as keys were written, or the population a filter read; null before the first recount. With list, a page of the people behind one count, paged by page, per and from (the cursor list.paging.nextFrom hands back); a realm list reads at most 20000 entries a request and says complete: false when that stopped it. NO COUNT IS A SCAN OF THE DIRECTORY: the realm’s are a maintained aggregate.
Mirrors GET /admin/passkey-report on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
group |
query | string | Count the members of this group only (its cn or its DN). At most 50000 members are read; population.complete says whether that was all of them. |
|
profile |
query | string | Count the people a NAMED passkey profile selects by group (#535, #1235: the members of the groups whose stsPasskeyPolicy names it), bounded as group is. default is refused: it selects nobody by group. |
|
application |
query | string | An application’s population: anybody may sign in to it, so the counts are the realm’s, with application saying which passkey profile governs its sign-ins and how many group-selected profiles could still win for a person. |
|
list |
query | one of post-quantum-only, classical-only, both, none, holding, algorithm, model |
The people behind one count: a kind (post-quantum-only, classical-only, both, none), everybody holding a passkey, one algorithm (with algorithm and, optionally, lane) or one model (with aaguid). |
|
algorithm |
query | string | With list=algorithm: the JOSE name, ML-DSA-65, ES256 and the like. |
|
lane |
query | one of classical, pqc |
With list=algorithm: only keys made in this lane (#643). |
|
aaguid |
query | string | With list=model: the AAGUID, or unreported for keys whose authenticator named none. |
|
page |
query | integer | Which page of list.rows. |
|
per |
query | integer | Rows per page. | |
from |
query | string | Where page starts: the nextFrom the page before answered. Without it a page is found by reading from the start. |
|
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 report.
| Member | Type | Required | What it is |
|---|---|---|---|
application |
object | ||
application.applies |
string, or null | ||
application.groupPolicies |
number | ||
application.identifier |
string | ||
application.missing |
boolean | ||
application.named |
string | ||
attestation |
object | ||
attestation.recorded |
boolean | ||
attestation.rows |
list | ||
attestation.rows[].algorithm |
string | ||
attestation.rows[].coseAlg |
integer, or null | ||
attestation.rows[].count |
number | ||
attestation.rows[].lane |
string | ||
attestation.rows[].postQuantum |
boolean | ||
counted |
object | ||
counted.at |
string, or number, or null | ||
counted.changesSince |
number, or null | ||
counted.durationMs |
number, or null | ||
counted.from |
string | ||
counted.holders |
number, or null | ||
counted.lastChangeAt |
string, or number, or null | ||
counted.startedAt |
string, or number, or null | ||
filter |
object | ||
filter.application |
string | ||
filter.group |
string | ||
filter.profile |
string | ||
filter.scope |
string | ||
generatedAt |
string | ||
installed |
boolean | ||
keys |
object | ||
keys.byAlgorithm |
list | ||
keys.byAlgorithm[].algorithm |
string | ||
keys.byAlgorithm[].coseAlg |
integer, or null | ||
keys.byAlgorithm[].count |
number | ||
keys.byAlgorithm[].lane |
string | ||
keys.byAlgorithm[].postQuantum |
boolean | ||
keys.byLane |
map | ||
keys.byLane.{key} |
number | ||
keys.classical |
number | ||
keys.postQuantum |
number | ||
keys.total |
number | ||
kinds |
list | ||
kinds[] |
string | ||
limits |
object | ||
limits.export |
integer | ||
limits.listScan |
integer | ||
limits.perMax |
integer | ||
limits.population |
integer | ||
list |
object | ||
list.aaguid |
string | ||
list.algorithm |
string, or null | ||
list.lane |
string, or null | ||
list.list |
string | ||
list.paging |
object | ||
list.paging.complete |
boolean | ||
list.paging.firstRow |
integer | ||
list.paging.hasNext |
boolean | ||
list.paging.lastRow |
integer | ||
list.paging.nextFrom |
string, or null | ||
list.paging.noun |
string | ||
list.paging.page |
integer | ||
list.paging.pages |
integer, or null | ||
list.paging.param |
string | ||
list.paging.perPage |
integer | ||
list.paging.scanned |
number | ||
list.paging.total |
integer, or null | ||
list.rows |
list | ||
list.rows[].dn |
string | ||
list.rows[].keys |
list | ||
list.rows[].keys[].aaguid |
string, or null | ||
list.rows[].keys[].algorithm |
string | ||
list.rows[].keys[].coseAlg |
integer, or null | ||
list.rows[].keys[].lane |
string | ||
list.rows[].keys[].model |
string, or null | ||
list.rows[].keys[].postQuantum |
boolean | ||
list.rows[].kind |
string | ||
list.rows[].passkeys |
integer | ||
list.rows[].username |
string | ||
lists |
list | ||
lists[] |
string | ||
models |
list | ||
models[].aaguid |
string | ||
models[].algorithms |
list | ||
models[].algorithms[].algorithm |
string | ||
models[].algorithms[].coseAlg |
integer, or null | ||
models[].algorithms[].count |
number | ||
models[].algorithms[].lane |
string | ||
models[].algorithms[].postQuantum |
boolean | ||
models[].name |
string | ||
models[].postQuantum |
boolean | ||
models[].total |
number | ||
ok |
boolean | ||
people |
object | ||
people.both |
number | ||
people.classicalOnly |
number | ||
people.holding |
number | ||
people.none |
number, or null | ||
people.postQuantumOnly |
number | ||
people.total |
number, or null | ||
people.withPostQuantum |
number | ||
population |
object | ||
population.complete |
boolean | ||
population.groups |
list | ||
population.groups[].asked |
string | ||
population.groups[].dn |
string, or null | ||
population.groups[].found |
boolean | ||
population.groups[].members |
number | ||
population.members |
number | ||
population.read |
number | ||
profile |
object | ||
profile.name |
string | ||
profile.namedByApplications |
list | ||
profile.namedByApplications[] |
string | ||
profile.postQuantumRequired |
string | ||
profile.precedence |
number | ||
profile.selectGroups |
list | ||
profile.selectGroups[] |
string | ||
profiles |
list | ||
profiles[].name |
string | ||
profiles[].namedByApplications |
list | ||
profiles[].namedByApplications[] |
string | ||
profiles[].postQuantumRequired |
string | ||
profiles[].precedence |
number | ||
profiles[].selectGroups |
list | ||
profiles[].selectGroups[] |
string | ||
realm |
string | ||
recount |
object | ||
recount.every |
string | ||
recount.job |
string |
400: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean |
GET /admin-api/passkey-report/evidence
exportPasskeyAttestationEvidence
Download one passkey RFC 4998 evidence record (#947)
Returns the exact archived attestation object and its RFC 4998 EvidenceRecord for one passkey. The TSA token is independently verifiable against the configured TSA trust anchors. A key has no evidence when no TSA was configured when it was enrolled, or when its attestation was not trusted and classical.
Mirrors GET /admin/users on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
username |
query | string | yes | |
credentialId |
query | string | yes | |
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 RFC 4998 EvidenceRecord and archived data.
| Member | Type | Required | What it is |
|---|---|---|---|
credentialId |
string | ||
evidence |
any JSON | The attestation statement an authenticator sent, archived as it was: its members are WebAuthn’s per attestation format. The attestation statement an authenticator sent, archived as it was: its members are WebAuthn’s per attestation format. | |
username |
string |
400: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean |
GET /admin-api/passkey-report/export
exportPasskeyReport
Every person behind one passkey count, as CSV or JSON
The people list names (every passkey holder when it is absent), in the filter the report takes, as a file: CSV (username, dn, kind, passkeys, algorithms, lanes, aaguids, models; a cell a spreadsheet would read as a formula is prefixed with an apostrophe) or JSON (rows, each with its keys). At most 100000 rows; the JSON says truncated, and so does the header X-Passkey-Report-Truncated. Read asynchronously, holders only, as the lists are. No secret is in it: a public key is not exported.
Mirrors GET /admin/passkey-report on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
group |
query | string | Count the members of this group only (its cn or its DN). At most 50000 members are read; population.complete says whether that was all of them. |
|
profile |
query | string | Count the people a NAMED passkey profile selects by group (#535, #1235: the members of the groups whose stsPasskeyPolicy names it), bounded as group is. default is refused: it selects nobody by group. |
|
application |
query | string | An application’s population: anybody may sign in to it, so the counts are the realm’s, with application saying which passkey profile governs its sign-ins and how many group-selected profiles could still win for a person. |
|
list |
query | one of post-quantum-only, classical-only, both, none, holding, algorithm, model |
The people behind one count: a kind (post-quantum-only, classical-only, both, none), everybody holding a passkey, one algorithm (with algorithm and, optionally, lane) or one model (with aaguid). |
|
algorithm |
query | string | With list=algorithm: the JOSE name, ML-DSA-65, ES256 and the like. |
|
lane |
query | one of classical, pqc |
With list=algorithm: only keys made in this lane (#643). |
|
aaguid |
query | string | With list=model: the AAGUID, or unreported for keys whose authenticator named none. |
|
format |
query | one of csv, json |
csv (the default) or json. |
|
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 file, as an attachment.
As application/json:
| Member | Type | Required | What it is |
|---|---|---|---|
filter |
object | ||
filter.application |
string | ||
filter.group |
string | ||
filter.profile |
string | ||
filter.scope |
string | ||
list |
string | ||
realm |
string | ||
rows |
list | ||
rows[].dn |
string | ||
rows[].keys |
list | ||
rows[].keys[].aaguid |
string, or null | ||
rows[].keys[].algorithm |
string | ||
rows[].keys[].coseAlg |
integer, or null | ||
rows[].keys[].lane |
string | ||
rows[].keys[].model |
string, or null | ||
rows[].keys[].postQuantum |
boolean | ||
rows[].kind |
string | ||
rows[].passkeys |
integer | ||
rows[].username |
string | ||
truncated |
boolean |
As text/csv.
400: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean |
POST /admin-api/passkey-report/recount
recountPasskeyReport
Count the realm’s passkeys again, now
Queues a run of the passkeys.report-recount job for this realm on the scheduler’s leader (#49), which reads every passkey holder a page at a time and makes the result the new baseline — putting right whatever the changes noted since could not see (a bulk import, a restore). It runs where every job runs, never on this request: the answer is the queued run (runId, alreadyQueued), and Monitoring → Scheduler shows it. Audited by the scheduler.
Mirrors POST /admin/passkey-report 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: The queued run.
| Member | Type | Required | What it is |
|---|---|---|---|
action |
string | ||
alreadyQueued |
boolean | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
runId |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
action |
string | ||
alreadyQueued |
boolean | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
runId |
string |