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 |
POST /admin-api/device-compliance
reportDeviceCompliance
Report device compliance (an MDM or posture feed)
One report, or reports — up to devices.complianceFeedMaxReports of them. Each names its device by id, by a key thumbprint (SHA-256, base64url: the SubjectPublicKeyInfo’s for a certificate, RFC 7638 for a JWK; optional keyKind x509, jwk or webauthn), or by its certificate (PEM), and says status — compliant or not-compliant — and an optional reason. It sets COMPLIANCE ONLY. Each is recorded with source mdm and the client as its actor, and a change a receiver can be told sends CAEP device-compliance-change (initiating_entity system). Every report is answered in results, in order; one naming no device is refused on its own (STS-DEVICE-0007) and the rest still apply. The access token must carry device:compliance, which the token endpoint issues only to a client whose oauthAllowedScope declares it, in both modes, and that HOLDS the DEVICE_COMPLIANCE role (#309, seeded with no member — add the feed on /admin/roles); an admin:write token is refused here, so a feed’s reports are always a feed’s.
Mirrors no console form — an MDM feed; an administrator uses the device page's set-compliance on the admin console.
Scope: device:compliance.
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 |
|---|---|---|---|
certificate |
string | ||
id |
string | ||
keyKind |
one of x509, jwk, webauthn |
||
reason |
string | ||
reports |
list | ||
reports[].certificate |
string | ||
reports[].id |
string | ||
reports[].keyKind |
one of x509, jwk, webauthn |
||
reports[].reason |
string | ||
reports[].status |
one of compliant, not-compliant |
||
reports[].thumbprint |
string | ||
status |
one of compliant, not-compliant |
||
thumbprint |
string |
200: applied, refused and results — per report its index, id, ok, previous, status, changed and signalled, or its errors.
| Member | Type | Required | What it is |
|---|---|---|---|
applied |
integer | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
refused |
integer | ||
results |
list | ||
results[].changed |
boolean | ||
results[].error |
string | ||
results[].errors |
list | ||
results[].errors[] |
string | ||
results[].id |
string | ||
results[].index |
integer | ||
results[].ok |
boolean | ||
results[].previous |
string | ||
results[].signalled |
boolean | ||
results[].status |
string |
400: The operation was refused; errors says why and nothing was handed over.
| Member | Type | Required | What it is |
|---|---|---|---|
applied |
integer | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
refused |
integer | ||
results |
list | ||
results[].changed |
boolean | ||
results[].error |
string | ||
results[].errors |
list | ||
results[].errors[] |
string | ||
results[].id |
string | ||
results[].index |
integer | ||
results[].ok |
boolean | ||
results[].previous |
string | ||
results[].signalled |
boolean | ||
results[].status |
string |
GET /admin-api/device-registration
getDeviceRegistration
How a device is registered and recognised here
enrolment — each method (native-sso, admin, portal, est, scep) with built and what — and recognition, the same for each kind of key; the vocabularies (ownerKinds, keyKinds, keyProofs, attestationLevels, attestationFormats, complianceStates, complianceSources), mdmFeed, and the Devices settings.
Mirrors GET /admin/device-registration on the admin console.
The reply also carries protocolEndpoints: every endpoint of this family in the realm the call arrived in, as { name, methods, url } (plus route for an HTTP endpoint, transport for a socket, and registered: false for a route the router no longer has).
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 enrolment methods and the settings.
| Member | Type | Required | What it is |
|---|---|---|---|
androidStatus |
object | ||
androidStatus.active |
string | ||
androidStatus.error |
string | ||
androidStatus.job |
string | ||
androidStatus.loadedAt |
number | ||
androidStatus.required |
boolean | ||
androidStatus.rows |
number | ||
androidStatus.stale |
boolean | ||
androidStatus.staleAfterHours |
number | ||
androidStatus.url |
string | ||
attestationFormats |
list | ||
attestationFormats[] |
string | ||
attestationLevels |
list | ||
attestationLevels[] |
string | ||
challenges |
object | ||
challenges.live |
integer | ||
challenges.max |
number | ||
challenges.perRealm |
boolean | ||
challenges.persisted |
boolean | ||
challenges.purposes |
list | ||
challenges.purposes[] |
string | ||
challenges.store |
string | ||
challenges.ttlSeconds |
number | ||
complianceSources |
list | ||
complianceSources[] |
string | ||
complianceStates |
list | ||
complianceStates[] |
string | ||
decisions |
object | ||
decisions.acr |
string | ||
decisions.claim |
string | ||
decisions.compliantDeviceAttested |
boolean | ||
decisions.expectRegistered |
boolean | ||
decisions.policy |
string | ||
decisions.refuseCompromised |
boolean | ||
decisions.requireCompliantDevice |
boolean | ||
decisions.riskSignals |
list | ||
decisions.riskSignals[] |
string | ||
enrolment |
list | ||
enrolment[].built |
boolean | ||
enrolment[].method |
string | ||
enrolment[].what |
string | ||
freshKeyAttestation |
object | ||
freshKeyAttestation.nonce |
string | ||
freshKeyAttestation.predicate |
string | ||
freshKeyAttestation.required |
boolean | ||
freshKeyAttestation.scep |
string | ||
keyKinds |
list | ||
keyKinds[] |
string | ||
keyProofs |
list | ||
keyProofs[] |
string | ||
mdmFeed |
object | ||
mdmFeed.built |
boolean | ||
mdmFeed.identifiedBy |
list | ||
mdmFeed.identifiedBy[] |
string | ||
mdmFeed.maxReports |
number | ||
mdmFeed.path |
string | ||
mdmFeed.role |
string | ||
mdmFeed.scope |
string | ||
mdmFeed.source |
string | ||
ownerKinds |
list | ||
ownerKinds[] |
string | ||
protocolEndpoints |
list | ||
protocolEndpoints[].listening |
boolean | ||
protocolEndpoints[].methods |
list, or string | ||
protocolEndpoints[].methods[] |
string | ||
protocolEndpoints[].name |
string | ||
protocolEndpoints[].registered |
boolean | ||
protocolEndpoints[].route |
string | ||
protocolEndpoints[].transport |
string | ||
protocolEndpoints[].url |
string | ||
receivedCaep |
object | ||
receivedCaep.built |
boolean | ||
receivedCaep.source |
string | ||
receivedCaep.via |
string | ||
recognition |
list | ||
recognition[].built |
boolean | ||
recognition[].kind |
string | ||
recognition[].what |
string | ||
recordedAt |
object | ||
recordedAt.signIn |
string | ||
recordedAt.tokenEndpoint |
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 the row’s own built-in default, the floor beneath both files: for a DERIVED setting it is a function of a neighbouring setting; for any other it means env/defaults.js lacks the setting (an env/ directory older than the image, which the start warns of as STS-CORE-0177). Only a setting with no default and 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 | ||
signals |
object | ||
signals.caep |
list | ||
signals.caep[] |
string | ||
signals.risc |
list | ||
signals.risc[] |
string | ||
signals.subject |
string | ||
trustAnchors |
list | ||
trustAnchors[].count |
integer, or null | ||
trustAnchors[].kind |
string | ||
trustAnchors[].setting |
string | ||
trustAnchors[].shipped |
list | ||
trustAnchors[].shipped[].notAfter |
string | ||
trustAnchors[].shipped[].sha256 |
string | ||
trustAnchors[].shipped[].subject |
string | ||
trustAnchors[].shipped[].used |
boolean | ||
trustAnchors[].source |
string | ||
unattestedKeys |
object | ||
unattestedKeys.accepted |
boolean | ||
unattestedKeys.adminKeys |
string | ||
unattestedKeys.predicate |
string |
GET /admin-api/devices
getDevices
Every device in this realm, paged and filtered, or one
Without device: total, matched, the filter applied, and devices — each id, dn, owner (a DN), ownerKind (person or application), ownerName, label, applications and applicationNames, keys (each id, kind, thumbprint, label, added, addedBy, proof, attestation, material), keyKinds, attestation (level, format, summary), compliance and complianceChange, status and statusChange, platform, model, os, enrolment, nativeSso, sessionLive, lastUsed, created — in devicesPaging. Never a Native SSO secret or its hash. With device, that one device as device, and found: false for an id the realm does not hold.
Mirrors GET /admin/devices on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
device |
query | string | One device’s id. | |
q |
query | string | A substring of the id, the label, the owner’s DN, a key’s thumbprint or label, the platform, model or OS. | |
ownerKind |
query | one of person, application |
Only devices a person, or an application, owns. | |
owner |
query | string | Only this owner’s: a username, an application identifier (with ownerKind=application) or a DN. |
|
application |
query | string | Only devices this application used. | |
compliance |
query | one of compliant, not-compliant, unknown |
Only devices in this compliance state. | |
attestation |
query | one of attested, self-asserted, bearer |
Only attested, self-asserted or bearer devices (a remembered browser, with no key of its own). | |
keyKind |
query | one of x509, jwk, webauthn, native-sso |
Only devices recognised by this kind of key. | |
status |
query | one of active, compromised |
Only active, or compromised, devices. | |
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 page of devices, or one device.
| Member | Type | Required | What it is |
|---|---|---|---|
device |
object | ||
device.applicationNames |
list | ||
device.applicationNames[] |
string | ||
device.applications |
list | ||
device.applications[] |
string | ||
device.attestation |
object | ||
device.attestation.format |
string | ||
device.attestation.keyId |
string | ||
device.attestation.level |
string | ||
device.attestation.summary |
string | ||
device.compliance |
string | ||
device.complianceChange |
object | ||
device.complianceChange.actor |
string | ||
device.complianceChange.at |
string | ||
device.complianceChange.previous |
string, or null | ||
device.complianceChange.reason |
string | ||
device.complianceChange.source |
string | ||
device.complianceChange.status |
string | ||
device.created |
string | ||
device.dn |
string | ||
device.enrolment |
object | ||
device.enrolment.actor |
string | ||
device.enrolment.at |
string | ||
device.enrolment.method |
string | ||
device.id |
string | ||
device.keyKinds |
list | ||
device.keyKinds[] |
string | ||
device.keys |
list | ||
device.keys[].added |
string | ||
device.keys[].addedBy |
string | ||
device.keys[].attestation |
object | ||
device.keys[].attestation.chainSerials |
list | ||
device.keys[].attestation.chainSerials[] |
string | ||
device.keys[].attestation.format |
string | ||
device.keys[].attestation.freshness |
object | ||
device.keys[].attestation.freshness.detail |
string | ||
device.keys[].attestation.freshness.status |
string | ||
device.keys[].attestation.level |
string | ||
device.keys[].attestation.revocation |
object | ||
device.keys[].attestation.revocation.chainSerials |
list | ||
device.keys[].attestation.revocation.chainSerials[] |
string | ||
device.keys[].attestation.revocation.checkedAt |
string, or number | ||
device.keys[].attestation.revocation.listVersion |
string | ||
device.keys[].attestation.revocation.reason |
string | ||
device.keys[].attestation.revocation.serial |
string | ||
device.keys[].attestation.revocation.status |
string | ||
device.keys[].attestation.revocation.why |
string | ||
device.keys[].attestation.summary |
string | ||
device.keys[].attestation.verifiedAt |
string | ||
device.keys[].id |
string | ||
device.keys[].kind |
string | ||
device.keys[].label |
string | ||
device.keys[].material |
object | ||
device.keys[].material.aaguid |
string | ||
device.keys[].material.attachment |
string | ||
device.keys[].material.certificate |
string | ||
device.keys[].material.credentialId |
string | ||
device.keys[].material.issuer |
string, or null | ||
device.keys[].material.jwk |
map | A public JWK’s members. | |
device.keys[].material.jwk.{key} |
list, or string, or boolean, or number | ||
device.keys[].material.jwk.{key}[] |
string | ||
device.keys[].material.notAfter |
string, or number, or null | ||
device.keys[].material.serial |
string, or null | ||
device.keys[].material.subject |
string, or null | ||
device.keys[].proof |
string | ||
device.keys[].thumbprint |
string | ||
device.label |
string | ||
device.lastUsed |
string | ||
device.model |
string | ||
device.nativeSso |
boolean | ||
device.os |
string | ||
device.owner |
string | ||
device.ownerFound |
boolean | ||
device.ownerKind |
string | ||
device.ownerName |
string | ||
device.platform |
string | ||
device.rememberedBrowser |
object | ||
device.rememberedBrowser.browser |
string | ||
device.rememberedBrowser.generation |
number | ||
device.rememberedBrowser.issuedAt |
string | ||
device.rememberedBrowser.secondFactorAt |
string | ||
device.riskChange |
object | ||
device.riskChange.actor |
string | ||
device.riskChange.at |
string | ||
device.riskChange.beforeCompromise |
string | ||
device.riskChange.level |
string | ||
device.riskChange.previous |
string, or null | ||
device.riskChange.reason |
string | ||
device.riskChange.source |
string | ||
device.riskLevel |
string | ||
device.sessionLive |
boolean | ||
device.status |
string | ||
device.statusChange |
object | ||
device.statusChange.actor |
string | ||
device.statusChange.at |
string | ||
device.statusChange.previous |
string, or null | ||
device.statusChange.reason |
string | ||
device.statusChange.source |
string | ||
device.statusChange.status |
string | ||
devices |
list | ||
devices[].applicationNames |
list | ||
devices[].applicationNames[] |
string | ||
devices[].applications |
list | ||
devices[].applications[] |
string | ||
devices[].attestation |
object | ||
devices[].attestation.format |
string | ||
devices[].attestation.keyId |
string | ||
devices[].attestation.level |
string | ||
devices[].attestation.summary |
string | ||
devices[].compliance |
string | ||
devices[].complianceChange |
object | ||
devices[].complianceChange.actor |
string | ||
devices[].complianceChange.at |
string | ||
devices[].complianceChange.previous |
string, or null | ||
devices[].complianceChange.reason |
string | ||
devices[].complianceChange.source |
string | ||
devices[].complianceChange.status |
string | ||
devices[].created |
string | ||
devices[].dn |
string | ||
devices[].enrolment |
object | ||
devices[].enrolment.actor |
string | ||
devices[].enrolment.at |
string | ||
devices[].enrolment.method |
string | ||
devices[].id |
string | ||
devices[].keyKinds |
list | ||
devices[].keyKinds[] |
string | ||
devices[].keys |
list | ||
devices[].keys[].added |
string | ||
devices[].keys[].addedBy |
string | ||
devices[].keys[].attestation |
object | ||
devices[].keys[].attestation.chainSerials |
list | ||
devices[].keys[].attestation.chainSerials[] |
string | ||
devices[].keys[].attestation.format |
string | ||
devices[].keys[].attestation.freshness |
object | ||
devices[].keys[].attestation.freshness.detail |
string | ||
devices[].keys[].attestation.freshness.status |
string | ||
devices[].keys[].attestation.level |
string | ||
devices[].keys[].attestation.revocation |
object | ||
devices[].keys[].attestation.revocation.chainSerials |
list | ||
devices[].keys[].attestation.revocation.chainSerials[] |
string | ||
devices[].keys[].attestation.revocation.checkedAt |
string, or number | ||
devices[].keys[].attestation.revocation.listVersion |
string | ||
devices[].keys[].attestation.revocation.reason |
string | ||
devices[].keys[].attestation.revocation.serial |
string | ||
devices[].keys[].attestation.revocation.status |
string | ||
devices[].keys[].attestation.revocation.why |
string | ||
devices[].keys[].attestation.summary |
string | ||
devices[].keys[].attestation.verifiedAt |
string | ||
devices[].keys[].id |
string | ||
devices[].keys[].kind |
string | ||
devices[].keys[].label |
string | ||
devices[].keys[].material |
object | ||
devices[].keys[].material.aaguid |
string | ||
devices[].keys[].material.attachment |
string | ||
devices[].keys[].material.certificate |
string | ||
devices[].keys[].material.credentialId |
string | ||
devices[].keys[].material.issuer |
string, or null | ||
devices[].keys[].material.jwk |
map | A public JWK’s members. | |
devices[].keys[].material.jwk.{key} |
list, or string, or boolean, or number | ||
devices[].keys[].material.jwk.{key}[] |
object | Nested deeper than this page draws. | |
devices[].keys[].material.notAfter |
string, or number, or null | ||
devices[].keys[].material.serial |
string, or null | ||
devices[].keys[].material.subject |
string, or null | ||
devices[].keys[].proof |
string | ||
devices[].keys[].thumbprint |
string | ||
devices[].label |
string | ||
devices[].lastUsed |
string | ||
devices[].model |
string | ||
devices[].nativeSso |
boolean | ||
devices[].os |
string | ||
devices[].owner |
string | ||
devices[].ownerFound |
boolean | ||
devices[].ownerKind |
string | ||
devices[].ownerName |
string | ||
devices[].platform |
string | ||
devices[].rememberedBrowser |
object | ||
devices[].rememberedBrowser.browser |
string | ||
devices[].rememberedBrowser.generation |
number | ||
devices[].rememberedBrowser.issuedAt |
string | ||
devices[].rememberedBrowser.secondFactorAt |
string | ||
devices[].riskChange |
object | ||
devices[].riskChange.actor |
string | ||
devices[].riskChange.at |
string | ||
devices[].riskChange.beforeCompromise |
string | ||
devices[].riskChange.level |
string | ||
devices[].riskChange.previous |
string, or null | ||
devices[].riskChange.reason |
string | ||
devices[].riskChange.source |
string | ||
devices[].riskLevel |
string | ||
devices[].sessionLive |
boolean | ||
devices[].status |
string | ||
devices[].statusChange |
object | ||
devices[].statusChange.actor |
string | ||
devices[].statusChange.at |
string | ||
devices[].statusChange.previous |
string, or null | ||
devices[].statusChange.reason |
string | ||
devices[].statusChange.source |
string | ||
devices[].statusChange.status |
string | ||
devicesPaging |
object | Which page of how many, and the query parameter that moves it. | |
devicesPaging.firstRow |
integer | ||
devicesPaging.lastRow |
integer | ||
devicesPaging.noun |
string | ||
devicesPaging.page |
integer | ||
devicesPaging.pages |
integer | ||
devicesPaging.param |
string | ||
devicesPaging.perPage |
integer | ||
devicesPaging.total |
integer | ||
filter |
map | What the list was narrowed by. | |
filter.{key} |
string | ||
found |
boolean | ||
id |
string | ||
matched |
integer | ||
page |
integer | ||
pages |
integer | ||
perPage |
integer | ||
total |
integer | ||
vocabulary |
object | ||
vocabulary.attestation |
list | ||
vocabulary.attestation[] |
string | ||
vocabulary.compliance |
list | ||
vocabulary.compliance[] |
string | ||
vocabulary.keyKinds |
list | ||
vocabulary.keyKinds[] |
string | ||
vocabulary.ownerKinds |
list | ||
vocabulary.ownerKinds[] |
string | ||
vocabulary.platforms |
list | ||
vocabulary.platforms[] |
string | ||
vocabulary.statuses |
list | ||
vocabulary.statuses[] |
string |
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/devices/add-key
addDeviceKey
Add a key a device is recognised by
kind x509 (a PEM certificate; its thumbprint is SHA-256 over the SubjectPublicKeyInfo), jwk (a PUBLIC JWK; RFC 7638, which is DPoP’s jkt) or webauthn (the credential id of a security key the device’s owner enrolled), in value. Recorded as proven by nobody and self-asserted. Refused for private material or an unreadable key (STS-DEVICE-0004), a key another device holds (STS-DEVICE-0005), or a device at devices.maxKeysPerDevice (STS-DEVICE-0006).
Mirrors POST /admin/devices 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 device id. |
kind |
one of x509, jwk, webauthn |
yes | |
label |
string | ||
value |
any JSON | yes | PEM, JWK (object or JSON) or credential id. |
200: The key added, by its id.
| Member | Type | Required | What it is |
|---|---|---|---|
certificatesRevoked |
number | ||
device |
object | ||
device.applicationNames |
list | ||
device.applicationNames[] |
string | ||
device.applications |
list | ||
device.applications[] |
string | ||
device.attestation |
object | ||
device.attestation.format |
string | ||
device.attestation.keyId |
string | ||
device.attestation.level |
string | ||
device.attestation.summary |
string | ||
device.compliance |
string | ||
device.complianceChange |
object | ||
device.complianceChange.actor |
string | ||
device.complianceChange.at |
string | ||
device.complianceChange.previous |
string, or null | ||
device.complianceChange.reason |
string | ||
device.complianceChange.source |
string | ||
device.complianceChange.status |
string | ||
device.created |
string | ||
device.dn |
string | ||
device.enrolment |
object | ||
device.enrolment.actor |
string | ||
device.enrolment.at |
string | ||
device.enrolment.method |
string | ||
device.id |
string | ||
device.keyKinds |
list | ||
device.keyKinds[] |
string | ||
device.keys |
list | ||
device.keys[].added |
string | ||
device.keys[].addedBy |
string | ||
device.keys[].attestation |
object | ||
device.keys[].attestation.chainSerials |
list | ||
device.keys[].attestation.chainSerials[] |
string | ||
device.keys[].attestation.format |
string | ||
device.keys[].attestation.freshness |
object | ||
device.keys[].attestation.freshness.detail |
string | ||
device.keys[].attestation.freshness.status |
string | ||
device.keys[].attestation.level |
string | ||
device.keys[].attestation.revocation |
object | ||
device.keys[].attestation.revocation.chainSerials |
list | ||
device.keys[].attestation.revocation.chainSerials[] |
string | ||
device.keys[].attestation.revocation.checkedAt |
string, or number | ||
device.keys[].attestation.revocation.listVersion |
string | ||
device.keys[].attestation.revocation.reason |
string | ||
device.keys[].attestation.revocation.serial |
string | ||
device.keys[].attestation.revocation.status |
string | ||
device.keys[].attestation.revocation.why |
string | ||
device.keys[].attestation.summary |
string | ||
device.keys[].attestation.verifiedAt |
string | ||
device.keys[].id |
string | ||
device.keys[].kind |
string | ||
device.keys[].label |
string | ||
device.keys[].material |
object | ||
device.keys[].material.aaguid |
string | ||
device.keys[].material.attachment |
string | ||
device.keys[].material.certificate |
string | ||
device.keys[].material.credentialId |
string | ||
device.keys[].material.issuer |
string, or null | ||
device.keys[].material.jwk |
map | A public JWK’s members. | |
device.keys[].material.jwk.{key} |
list, or string, or boolean, or number | ||
device.keys[].material.jwk.{key}[] |
string | ||
device.keys[].material.notAfter |
string, or number, or null | ||
device.keys[].material.serial |
string, or null | ||
device.keys[].material.subject |
string, or null | ||
device.keys[].proof |
string | ||
device.keys[].thumbprint |
string | ||
device.label |
string | ||
device.lastUsed |
string | ||
device.model |
string | ||
device.nativeSso |
boolean | ||
device.os |
string | ||
device.owner |
string | ||
device.ownerFound |
boolean | ||
device.ownerKind |
string | ||
device.ownerName |
string | ||
device.platform |
string | ||
device.rememberedBrowser |
object | ||
device.rememberedBrowser.browser |
string | ||
device.rememberedBrowser.generation |
number | ||
device.rememberedBrowser.issuedAt |
string | ||
device.rememberedBrowser.secondFactorAt |
string | ||
device.riskChange |
object | ||
device.riskChange.actor |
string | ||
device.riskChange.at |
string | ||
device.riskChange.beforeCompromise |
string | ||
device.riskChange.level |
string | ||
device.riskChange.previous |
string, or null | ||
device.riskChange.reason |
string | ||
device.riskChange.source |
string | ||
device.riskLevel |
string | ||
device.sessionLive |
boolean | ||
device.status |
string | ||
device.statusChange |
object | ||
device.statusChange.actor |
string | ||
device.statusChange.at |
string | ||
device.statusChange.previous |
string, or null | ||
device.statusChange.reason |
string | ||
device.statusChange.source |
string | ||
device.statusChange.status |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
id |
string | ||
key |
string | The key’s id. | |
message |
string | ||
ok |
boolean | yes | |
previous |
string | ||
sessionsEnded |
number | ||
status |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
certificatesRevoked |
number | ||
device |
object | ||
device.applicationNames |
list | ||
device.applicationNames[] |
string | ||
device.applications |
list | ||
device.applications[] |
string | ||
device.attestation |
object | ||
device.attestation.format |
string | ||
device.attestation.keyId |
string | ||
device.attestation.level |
string | ||
device.attestation.summary |
string | ||
device.compliance |
string | ||
device.complianceChange |
object | ||
device.complianceChange.actor |
string | ||
device.complianceChange.at |
string | ||
device.complianceChange.previous |
string, or null | ||
device.complianceChange.reason |
string | ||
device.complianceChange.source |
string | ||
device.complianceChange.status |
string | ||
device.created |
string | ||
device.dn |
string | ||
device.enrolment |
object | ||
device.enrolment.actor |
string | ||
device.enrolment.at |
string | ||
device.enrolment.method |
string | ||
device.id |
string | ||
device.keyKinds |
list | ||
device.keyKinds[] |
string | ||
device.keys |
list | ||
device.keys[].added |
string | ||
device.keys[].addedBy |
string | ||
device.keys[].attestation |
object | ||
device.keys[].attestation.chainSerials |
list | ||
device.keys[].attestation.chainSerials[] |
string | ||
device.keys[].attestation.format |
string | ||
device.keys[].attestation.freshness |
object | ||
device.keys[].attestation.freshness.detail |
string | ||
device.keys[].attestation.freshness.status |
string | ||
device.keys[].attestation.level |
string | ||
device.keys[].attestation.revocation |
object | ||
device.keys[].attestation.revocation.chainSerials |
list | ||
device.keys[].attestation.revocation.chainSerials[] |
string | ||
device.keys[].attestation.revocation.checkedAt |
string, or number | ||
device.keys[].attestation.revocation.listVersion |
string | ||
device.keys[].attestation.revocation.reason |
string | ||
device.keys[].attestation.revocation.serial |
string | ||
device.keys[].attestation.revocation.status |
string | ||
device.keys[].attestation.revocation.why |
string | ||
device.keys[].attestation.summary |
string | ||
device.keys[].attestation.verifiedAt |
string | ||
device.keys[].id |
string | ||
device.keys[].kind |
string | ||
device.keys[].label |
string | ||
device.keys[].material |
object | ||
device.keys[].material.aaguid |
string | ||
device.keys[].material.attachment |
string | ||
device.keys[].material.certificate |
string | ||
device.keys[].material.credentialId |
string | ||
device.keys[].material.issuer |
string, or null | ||
device.keys[].material.jwk |
map | A public JWK’s members. | |
device.keys[].material.jwk.{key} |
list, or string, or boolean, or number | ||
device.keys[].material.jwk.{key}[] |
string | ||
device.keys[].material.notAfter |
string, or number, or null | ||
device.keys[].material.serial |
string, or null | ||
device.keys[].material.subject |
string, or null | ||
device.keys[].proof |
string | ||
device.keys[].thumbprint |
string | ||
device.label |
string | ||
device.lastUsed |
string | ||
device.model |
string | ||
device.nativeSso |
boolean | ||
device.os |
string | ||
device.owner |
string | ||
device.ownerFound |
boolean | ||
device.ownerKind |
string | ||
device.ownerName |
string | ||
device.platform |
string | ||
device.rememberedBrowser |
object | ||
device.rememberedBrowser.browser |
string | ||
device.rememberedBrowser.generation |
number | ||
device.rememberedBrowser.issuedAt |
string | ||
device.rememberedBrowser.secondFactorAt |
string | ||
device.riskChange |
object | ||
device.riskChange.actor |
string | ||
device.riskChange.at |
string | ||
device.riskChange.beforeCompromise |
string | ||
device.riskChange.level |
string | ||
device.riskChange.previous |
string, or null | ||
device.riskChange.reason |
string | ||
device.riskChange.source |
string | ||
device.riskLevel |
string | ||
device.sessionLive |
boolean | ||
device.status |
string | ||
device.statusChange |
object | ||
device.statusChange.actor |
string | ||
device.statusChange.at |
string | ||
device.statusChange.previous |
string, or null | ||
device.statusChange.reason |
string | ||
device.statusChange.source |
string | ||
device.statusChange.status |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
id |
string | ||
key |
string | The key’s id. | |
message |
string | ||
ok |
boolean | yes | |
previous |
string | ||
sessionsEnded |
number | ||
status |
string |
POST /admin-api/devices/create
createDevice
Register a device, owned by a person or an application
A device entry under ou=devices owned by owner — a username, or with ownerKind application an application’s identifier — with an optional label, platform, model, os, the applications that use it, and its first keys, either keys (each kind and value: a PEM certificate, a public JWK or a security key’s credential id the owner enrolled) or one as keyKind and key. Every key is recorded as proven by nobody and self-asserted. Refused for an owner the directory does not hold (STS-DEVICE-0001), an owner at its bound (STS-DEVICE-0002, STS-DEVICE-0003 — nothing is removed to make room), a key that is private, unreadable (STS-DEVICE-0004) or another device’s (STS-DEVICE-0005).
Mirrors POST /admin/devices 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 |
|---|---|---|---|
applications |
any JSON | Client ids or application identifiers: an array, or one string, comma separated. | |
key |
any JSON | One key, with keyKind. | |
keyKind |
one of x509, jwk, webauthn |
||
keyLabel |
string | ||
keys |
list | ||
keys[].kind |
one of x509, jwk, webauthn |
||
keys[].label |
string | ||
keys[].value |
any JSON | PEM, JWK (object or JSON) or credential id. | |
label |
string | ||
model |
string | ||
os |
string | ||
owner |
string | yes | A username, an application identifier or a DN. |
ownerKind |
one of person, application |
||
platform |
string | ios, ipados, android, macos, windows, linux, chromeos, other or empty. |
200: The device registered, as device.
| Member | Type | Required | What it is |
|---|---|---|---|
certificatesRevoked |
number | ||
device |
object | ||
device.applicationNames |
list | ||
device.applicationNames[] |
string | ||
device.applications |
list | ||
device.applications[] |
string | ||
device.attestation |
object | ||
device.attestation.format |
string | ||
device.attestation.keyId |
string | ||
device.attestation.level |
string | ||
device.attestation.summary |
string | ||
device.compliance |
string | ||
device.complianceChange |
object | ||
device.complianceChange.actor |
string | ||
device.complianceChange.at |
string | ||
device.complianceChange.previous |
string, or null | ||
device.complianceChange.reason |
string | ||
device.complianceChange.source |
string | ||
device.complianceChange.status |
string | ||
device.created |
string | ||
device.dn |
string | ||
device.enrolment |
object | ||
device.enrolment.actor |
string | ||
device.enrolment.at |
string | ||
device.enrolment.method |
string | ||
device.id |
string | ||
device.keyKinds |
list | ||
device.keyKinds[] |
string | ||
device.keys |
list | ||
device.keys[].added |
string | ||
device.keys[].addedBy |
string | ||
device.keys[].attestation |
object | ||
device.keys[].attestation.chainSerials |
list | ||
device.keys[].attestation.chainSerials[] |
string | ||
device.keys[].attestation.format |
string | ||
device.keys[].attestation.freshness |
object | ||
device.keys[].attestation.freshness.detail |
string | ||
device.keys[].attestation.freshness.status |
string | ||
device.keys[].attestation.level |
string | ||
device.keys[].attestation.revocation |
object | ||
device.keys[].attestation.revocation.chainSerials |
list | ||
device.keys[].attestation.revocation.chainSerials[] |
string | ||
device.keys[].attestation.revocation.checkedAt |
string, or number | ||
device.keys[].attestation.revocation.listVersion |
string | ||
device.keys[].attestation.revocation.reason |
string | ||
device.keys[].attestation.revocation.serial |
string | ||
device.keys[].attestation.revocation.status |
string | ||
device.keys[].attestation.revocation.why |
string | ||
device.keys[].attestation.summary |
string | ||
device.keys[].attestation.verifiedAt |
string | ||
device.keys[].id |
string | ||
device.keys[].kind |
string | ||
device.keys[].label |
string | ||
device.keys[].material |
object | ||
device.keys[].material.aaguid |
string | ||
device.keys[].material.attachment |
string | ||
device.keys[].material.certificate |
string | ||
device.keys[].material.credentialId |
string | ||
device.keys[].material.issuer |
string, or null | ||
device.keys[].material.jwk |
map | A public JWK’s members. | |
device.keys[].material.jwk.{key} |
list, or string, or boolean, or number | ||
device.keys[].material.jwk.{key}[] |
string | ||
device.keys[].material.notAfter |
string, or number, or null | ||
device.keys[].material.serial |
string, or null | ||
device.keys[].material.subject |
string, or null | ||
device.keys[].proof |
string | ||
device.keys[].thumbprint |
string | ||
device.label |
string | ||
device.lastUsed |
string | ||
device.model |
string | ||
device.nativeSso |
boolean | ||
device.os |
string | ||
device.owner |
string | ||
device.ownerFound |
boolean | ||
device.ownerKind |
string | ||
device.ownerName |
string | ||
device.platform |
string | ||
device.rememberedBrowser |
object | ||
device.rememberedBrowser.browser |
string | ||
device.rememberedBrowser.generation |
number | ||
device.rememberedBrowser.issuedAt |
string | ||
device.rememberedBrowser.secondFactorAt |
string | ||
device.riskChange |
object | ||
device.riskChange.actor |
string | ||
device.riskChange.at |
string | ||
device.riskChange.beforeCompromise |
string | ||
device.riskChange.level |
string | ||
device.riskChange.previous |
string, or null | ||
device.riskChange.reason |
string | ||
device.riskChange.source |
string | ||
device.riskLevel |
string | ||
device.sessionLive |
boolean | ||
device.status |
string | ||
device.statusChange |
object | ||
device.statusChange.actor |
string | ||
device.statusChange.at |
string | ||
device.statusChange.previous |
string, or null | ||
device.statusChange.reason |
string | ||
device.statusChange.source |
string | ||
device.statusChange.status |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
id |
string | ||
key |
string | The key’s id. | |
message |
string | ||
ok |
boolean | yes | |
previous |
string | ||
sessionsEnded |
number | ||
status |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
certificatesRevoked |
number | ||
device |
object | ||
device.applicationNames |
list | ||
device.applicationNames[] |
string | ||
device.applications |
list | ||
device.applications[] |
string | ||
device.attestation |
object | ||
device.attestation.format |
string | ||
device.attestation.keyId |
string | ||
device.attestation.level |
string | ||
device.attestation.summary |
string | ||
device.compliance |
string | ||
device.complianceChange |
object | ||
device.complianceChange.actor |
string | ||
device.complianceChange.at |
string | ||
device.complianceChange.previous |
string, or null | ||
device.complianceChange.reason |
string | ||
device.complianceChange.source |
string | ||
device.complianceChange.status |
string | ||
device.created |
string | ||
device.dn |
string | ||
device.enrolment |
object | ||
device.enrolment.actor |
string | ||
device.enrolment.at |
string | ||
device.enrolment.method |
string | ||
device.id |
string | ||
device.keyKinds |
list | ||
device.keyKinds[] |
string | ||
device.keys |
list | ||
device.keys[].added |
string | ||
device.keys[].addedBy |
string | ||
device.keys[].attestation |
object | ||
device.keys[].attestation.chainSerials |
list | ||
device.keys[].attestation.chainSerials[] |
string | ||
device.keys[].attestation.format |
string | ||
device.keys[].attestation.freshness |
object | ||
device.keys[].attestation.freshness.detail |
string | ||
device.keys[].attestation.freshness.status |
string | ||
device.keys[].attestation.level |
string | ||
device.keys[].attestation.revocation |
object | ||
device.keys[].attestation.revocation.chainSerials |
list | ||
device.keys[].attestation.revocation.chainSerials[] |
string | ||
device.keys[].attestation.revocation.checkedAt |
string, or number | ||
device.keys[].attestation.revocation.listVersion |
string | ||
device.keys[].attestation.revocation.reason |
string | ||
device.keys[].attestation.revocation.serial |
string | ||
device.keys[].attestation.revocation.status |
string | ||
device.keys[].attestation.revocation.why |
string | ||
device.keys[].attestation.summary |
string | ||
device.keys[].attestation.verifiedAt |
string | ||
device.keys[].id |
string | ||
device.keys[].kind |
string | ||
device.keys[].label |
string | ||
device.keys[].material |
object | ||
device.keys[].material.aaguid |
string | ||
device.keys[].material.attachment |
string | ||
device.keys[].material.certificate |
string | ||
device.keys[].material.credentialId |
string | ||
device.keys[].material.issuer |
string, or null | ||
device.keys[].material.jwk |
map | A public JWK’s members. | |
device.keys[].material.jwk.{key} |
list, or string, or boolean, or number | ||
device.keys[].material.jwk.{key}[] |
string | ||
device.keys[].material.notAfter |
string, or number, or null | ||
device.keys[].material.serial |
string, or null | ||
device.keys[].material.subject |
string, or null | ||
device.keys[].proof |
string | ||
device.keys[].thumbprint |
string | ||
device.label |
string | ||
device.lastUsed |
string | ||
device.model |
string | ||
device.nativeSso |
boolean | ||
device.os |
string | ||
device.owner |
string | ||
device.ownerFound |
boolean | ||
device.ownerKind |
string | ||
device.ownerName |
string | ||
device.platform |
string | ||
device.rememberedBrowser |
object | ||
device.rememberedBrowser.browser |
string | ||
device.rememberedBrowser.generation |
number | ||
device.rememberedBrowser.issuedAt |
string | ||
device.rememberedBrowser.secondFactorAt |
string | ||
device.riskChange |
object | ||
device.riskChange.actor |
string | ||
device.riskChange.at |
string | ||
device.riskChange.beforeCompromise |
string | ||
device.riskChange.level |
string | ||
device.riskChange.previous |
string, or null | ||
device.riskChange.reason |
string | ||
device.riskChange.source |
string | ||
device.riskLevel |
string | ||
device.sessionLive |
boolean | ||
device.status |
string | ||
device.statusChange |
object | ||
device.statusChange.actor |
string | ||
device.statusChange.at |
string | ||
device.statusChange.previous |
string, or null | ||
device.statusChange.reason |
string | ||
device.statusChange.source |
string | ||
device.statusChange.status |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
id |
string | ||
key |
string | The key’s id. | |
message |
string | ||
ok |
boolean | yes | |
previous |
string | ||
sessionsEnded |
number | ||
status |
string |
GET /admin-api/devices/monitor
getDevicesMonitor
The device register counted, and its events day by day
counts — total, keys, and byOwnerKind, byCompliance, byAttestation, byKeyKind, byEnrolment, byStatus, and nativeSso (live, ended, none), with windowed, counted and complete: where the directory is a window onto the store, total is the store’s count and the tables cover the first counted devices — and timeline: days, one row per UTC day (day, created, removed, evicted), the totals over every event kept and since, the oldest. A removal by an ldapdelete on the socket is not an event.
Mirrors GET /admin/devices/monitor on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
days |
query | integer | How many days the timeline covers; 30 by default. | |
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 counts and the timeline.
| Member | Type | Required | What it is |
|---|---|---|---|
activity |
object | ||
activity.attestationFormats |
map | ||
activity.attestationFormats.{key} |
number | ||
activity.attestationLevels |
map | ||
activity.attestationLevels.{key} |
number | ||
activity.attestationRefusals |
map | ||
activity.attestationRefusals.{key} |
number | ||
activity.enrolments |
map | ||
activity.enrolments.{key} |
number | ||
activity.recognitions |
map | ||
activity.recognitions.{key} |
number | ||
activity.scope |
string | ||
complianceSources |
list | ||
complianceSources[] |
string | ||
counts |
object | ||
counts.byAttestation |
map | ||
counts.byAttestation.{key} |
number | ||
counts.byCompliance |
map | ||
counts.byCompliance.{key} |
number | ||
counts.byEnrolment |
map | ||
counts.byEnrolment.{key} |
number | ||
counts.byKeyAttestationFormat |
map | ||
counts.byKeyAttestationFormat.{key} |
number | ||
counts.byKeyKind |
map | ||
counts.byKeyKind.{key} |
number | ||
counts.byOwnerKind |
map | ||
counts.byOwnerKind.{key} |
number | ||
counts.byRiskLevel |
map | ||
counts.byRiskLevel.{key} |
number | ||
counts.byStatus |
map | ||
counts.byStatus.{key} |
number | ||
counts.complete |
boolean | ||
counts.counted |
number | ||
counts.keys |
number | ||
counts.nativeSso |
object | ||
counts.nativeSso.ended |
number | ||
counts.nativeSso.live |
number | ||
counts.nativeSso.none |
number | ||
counts.total |
number | ||
counts.windowed |
boolean | ||
timeline |
object | ||
timeline.days |
integer | ||
timeline.rows |
list | ||
timeline.rows[].compliance |
map | ||
timeline.rows[].compliance.{key} |
number | ||
timeline.rows[].created |
number | ||
timeline.rows[].day |
string | ||
timeline.rows[].evicted |
number | ||
timeline.rows[].removed |
number | ||
timeline.since |
string | ||
timeline.totals |
object | ||
timeline.totals.compliance |
map | ||
timeline.totals.compliance.{key} |
number | ||
timeline.totals.created |
number | ||
timeline.totals.evicted |
number | ||
timeline.totals.removed |
number |
POST /admin-api/devices/remove
removeDevice
Remove a device
Deletes the device entry, its keys and any Native SSO secret with it. Refused for an unknown device (STS-DEVICE-0007).
Mirrors POST /admin/devices 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 device id. |
200: Whether it was removed.
| Member | Type | Required | What it is |
|---|---|---|---|
certificatesRevoked |
number | ||
device |
object | ||
device.applicationNames |
list | ||
device.applicationNames[] |
string | ||
device.applications |
list | ||
device.applications[] |
string | ||
device.attestation |
object | ||
device.attestation.format |
string | ||
device.attestation.keyId |
string | ||
device.attestation.level |
string | ||
device.attestation.summary |
string | ||
device.compliance |
string | ||
device.complianceChange |
object | ||
device.complianceChange.actor |
string | ||
device.complianceChange.at |
string | ||
device.complianceChange.previous |
string, or null | ||
device.complianceChange.reason |
string | ||
device.complianceChange.source |
string | ||
device.complianceChange.status |
string | ||
device.created |
string | ||
device.dn |
string | ||
device.enrolment |
object | ||
device.enrolment.actor |
string | ||
device.enrolment.at |
string | ||
device.enrolment.method |
string | ||
device.id |
string | ||
device.keyKinds |
list | ||
device.keyKinds[] |
string | ||
device.keys |
list | ||
device.keys[].added |
string | ||
device.keys[].addedBy |
string | ||
device.keys[].attestation |
object | ||
device.keys[].attestation.chainSerials |
list | ||
device.keys[].attestation.chainSerials[] |
string | ||
device.keys[].attestation.format |
string | ||
device.keys[].attestation.freshness |
object | ||
device.keys[].attestation.freshness.detail |
string | ||
device.keys[].attestation.freshness.status |
string | ||
device.keys[].attestation.level |
string | ||
device.keys[].attestation.revocation |
object | ||
device.keys[].attestation.revocation.chainSerials |
list | ||
device.keys[].attestation.revocation.chainSerials[] |
string | ||
device.keys[].attestation.revocation.checkedAt |
string, or number | ||
device.keys[].attestation.revocation.listVersion |
string | ||
device.keys[].attestation.revocation.reason |
string | ||
device.keys[].attestation.revocation.serial |
string | ||
device.keys[].attestation.revocation.status |
string | ||
device.keys[].attestation.revocation.why |
string | ||
device.keys[].attestation.summary |
string | ||
device.keys[].attestation.verifiedAt |
string | ||
device.keys[].id |
string | ||
device.keys[].kind |
string | ||
device.keys[].label |
string | ||
device.keys[].material |
object | ||
device.keys[].material.aaguid |
string | ||
device.keys[].material.attachment |
string | ||
device.keys[].material.certificate |
string | ||
device.keys[].material.credentialId |
string | ||
device.keys[].material.issuer |
string, or null | ||
device.keys[].material.jwk |
map | A public JWK’s members. | |
device.keys[].material.jwk.{key} |
list, or string, or boolean, or number | ||
device.keys[].material.jwk.{key}[] |
string | ||
device.keys[].material.notAfter |
string, or number, or null | ||
device.keys[].material.serial |
string, or null | ||
device.keys[].material.subject |
string, or null | ||
device.keys[].proof |
string | ||
device.keys[].thumbprint |
string | ||
device.label |
string | ||
device.lastUsed |
string | ||
device.model |
string | ||
device.nativeSso |
boolean | ||
device.os |
string | ||
device.owner |
string | ||
device.ownerFound |
boolean | ||
device.ownerKind |
string | ||
device.ownerName |
string | ||
device.platform |
string | ||
device.rememberedBrowser |
object | ||
device.rememberedBrowser.browser |
string | ||
device.rememberedBrowser.generation |
number | ||
device.rememberedBrowser.issuedAt |
string | ||
device.rememberedBrowser.secondFactorAt |
string | ||
device.riskChange |
object | ||
device.riskChange.actor |
string | ||
device.riskChange.at |
string | ||
device.riskChange.beforeCompromise |
string | ||
device.riskChange.level |
string | ||
device.riskChange.previous |
string, or null | ||
device.riskChange.reason |
string | ||
device.riskChange.source |
string | ||
device.riskLevel |
string | ||
device.sessionLive |
boolean | ||
device.status |
string | ||
device.statusChange |
object | ||
device.statusChange.actor |
string | ||
device.statusChange.at |
string | ||
device.statusChange.previous |
string, or null | ||
device.statusChange.reason |
string | ||
device.statusChange.source |
string | ||
device.statusChange.status |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
id |
string | ||
key |
string | The key’s id. | |
message |
string | ||
ok |
boolean | yes | |
previous |
string | ||
sessionsEnded |
number | ||
status |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
certificatesRevoked |
number | ||
device |
object | ||
device.applicationNames |
list | ||
device.applicationNames[] |
string | ||
device.applications |
list | ||
device.applications[] |
string | ||
device.attestation |
object | ||
device.attestation.format |
string | ||
device.attestation.keyId |
string | ||
device.attestation.level |
string | ||
device.attestation.summary |
string | ||
device.compliance |
string | ||
device.complianceChange |
object | ||
device.complianceChange.actor |
string | ||
device.complianceChange.at |
string | ||
device.complianceChange.previous |
string, or null | ||
device.complianceChange.reason |
string | ||
device.complianceChange.source |
string | ||
device.complianceChange.status |
string | ||
device.created |
string | ||
device.dn |
string | ||
device.enrolment |
object | ||
device.enrolment.actor |
string | ||
device.enrolment.at |
string | ||
device.enrolment.method |
string | ||
device.id |
string | ||
device.keyKinds |
list | ||
device.keyKinds[] |
string | ||
device.keys |
list | ||
device.keys[].added |
string | ||
device.keys[].addedBy |
string | ||
device.keys[].attestation |
object | ||
device.keys[].attestation.chainSerials |
list | ||
device.keys[].attestation.chainSerials[] |
string | ||
device.keys[].attestation.format |
string | ||
device.keys[].attestation.freshness |
object | ||
device.keys[].attestation.freshness.detail |
string | ||
device.keys[].attestation.freshness.status |
string | ||
device.keys[].attestation.level |
string | ||
device.keys[].attestation.revocation |
object | ||
device.keys[].attestation.revocation.chainSerials |
list | ||
device.keys[].attestation.revocation.chainSerials[] |
string | ||
device.keys[].attestation.revocation.checkedAt |
string, or number | ||
device.keys[].attestation.revocation.listVersion |
string | ||
device.keys[].attestation.revocation.reason |
string | ||
device.keys[].attestation.revocation.serial |
string | ||
device.keys[].attestation.revocation.status |
string | ||
device.keys[].attestation.revocation.why |
string | ||
device.keys[].attestation.summary |
string | ||
device.keys[].attestation.verifiedAt |
string | ||
device.keys[].id |
string | ||
device.keys[].kind |
string | ||
device.keys[].label |
string | ||
device.keys[].material |
object | ||
device.keys[].material.aaguid |
string | ||
device.keys[].material.attachment |
string | ||
device.keys[].material.certificate |
string | ||
device.keys[].material.credentialId |
string | ||
device.keys[].material.issuer |
string, or null | ||
device.keys[].material.jwk |
map | A public JWK’s members. | |
device.keys[].material.jwk.{key} |
list, or string, or boolean, or number | ||
device.keys[].material.jwk.{key}[] |
string | ||
device.keys[].material.notAfter |
string, or number, or null | ||
device.keys[].material.serial |
string, or null | ||
device.keys[].material.subject |
string, or null | ||
device.keys[].proof |
string | ||
device.keys[].thumbprint |
string | ||
device.label |
string | ||
device.lastUsed |
string | ||
device.model |
string | ||
device.nativeSso |
boolean | ||
device.os |
string | ||
device.owner |
string | ||
device.ownerFound |
boolean | ||
device.ownerKind |
string | ||
device.ownerName |
string | ||
device.platform |
string | ||
device.rememberedBrowser |
object | ||
device.rememberedBrowser.browser |
string | ||
device.rememberedBrowser.generation |
number | ||
device.rememberedBrowser.issuedAt |
string | ||
device.rememberedBrowser.secondFactorAt |
string | ||
device.riskChange |
object | ||
device.riskChange.actor |
string | ||
device.riskChange.at |
string | ||
device.riskChange.beforeCompromise |
string | ||
device.riskChange.level |
string | ||
device.riskChange.previous |
string, or null | ||
device.riskChange.reason |
string | ||
device.riskChange.source |
string | ||
device.riskLevel |
string | ||
device.sessionLive |
boolean | ||
device.status |
string | ||
device.statusChange |
object | ||
device.statusChange.actor |
string | ||
device.statusChange.at |
string | ||
device.statusChange.previous |
string, or null | ||
device.statusChange.reason |
string | ||
device.statusChange.source |
string | ||
device.statusChange.status |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
id |
string | ||
key |
string | The key’s id. | |
message |
string | ||
ok |
boolean | yes | |
previous |
string | ||
sessionsEnded |
number | ||
status |
string |
POST /admin-api/devices/remove-key
removeDeviceKey
Remove one of a device’s keys
key is the key’s id or its thumbprint. Refused for an unknown device (STS-DEVICE-0007) or a key it does not hold (STS-DEVICE-0008).
Mirrors POST /admin/devices 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 device id. |
key |
string | yes | The key id or thumbprint. |
200: Whether the key was removed.
| Member | Type | Required | What it is |
|---|---|---|---|
certificatesRevoked |
number | ||
device |
object | ||
device.applicationNames |
list | ||
device.applicationNames[] |
string | ||
device.applications |
list | ||
device.applications[] |
string | ||
device.attestation |
object | ||
device.attestation.format |
string | ||
device.attestation.keyId |
string | ||
device.attestation.level |
string | ||
device.attestation.summary |
string | ||
device.compliance |
string | ||
device.complianceChange |
object | ||
device.complianceChange.actor |
string | ||
device.complianceChange.at |
string | ||
device.complianceChange.previous |
string, or null | ||
device.complianceChange.reason |
string | ||
device.complianceChange.source |
string | ||
device.complianceChange.status |
string | ||
device.created |
string | ||
device.dn |
string | ||
device.enrolment |
object | ||
device.enrolment.actor |
string | ||
device.enrolment.at |
string | ||
device.enrolment.method |
string | ||
device.id |
string | ||
device.keyKinds |
list | ||
device.keyKinds[] |
string | ||
device.keys |
list | ||
device.keys[].added |
string | ||
device.keys[].addedBy |
string | ||
device.keys[].attestation |
object | ||
device.keys[].attestation.chainSerials |
list | ||
device.keys[].attestation.chainSerials[] |
string | ||
device.keys[].attestation.format |
string | ||
device.keys[].attestation.freshness |
object | ||
device.keys[].attestation.freshness.detail |
string | ||
device.keys[].attestation.freshness.status |
string | ||
device.keys[].attestation.level |
string | ||
device.keys[].attestation.revocation |
object | ||
device.keys[].attestation.revocation.chainSerials |
list | ||
device.keys[].attestation.revocation.chainSerials[] |
string | ||
device.keys[].attestation.revocation.checkedAt |
string, or number | ||
device.keys[].attestation.revocation.listVersion |
string | ||
device.keys[].attestation.revocation.reason |
string | ||
device.keys[].attestation.revocation.serial |
string | ||
device.keys[].attestation.revocation.status |
string | ||
device.keys[].attestation.revocation.why |
string | ||
device.keys[].attestation.summary |
string | ||
device.keys[].attestation.verifiedAt |
string | ||
device.keys[].id |
string | ||
device.keys[].kind |
string | ||
device.keys[].label |
string | ||
device.keys[].material |
object | ||
device.keys[].material.aaguid |
string | ||
device.keys[].material.attachment |
string | ||
device.keys[].material.certificate |
string | ||
device.keys[].material.credentialId |
string | ||
device.keys[].material.issuer |
string, or null | ||
device.keys[].material.jwk |
map | A public JWK’s members. | |
device.keys[].material.jwk.{key} |
list, or string, or boolean, or number | ||
device.keys[].material.jwk.{key}[] |
string | ||
device.keys[].material.notAfter |
string, or number, or null | ||
device.keys[].material.serial |
string, or null | ||
device.keys[].material.subject |
string, or null | ||
device.keys[].proof |
string | ||
device.keys[].thumbprint |
string | ||
device.label |
string | ||
device.lastUsed |
string | ||
device.model |
string | ||
device.nativeSso |
boolean | ||
device.os |
string | ||
device.owner |
string | ||
device.ownerFound |
boolean | ||
device.ownerKind |
string | ||
device.ownerName |
string | ||
device.platform |
string | ||
device.rememberedBrowser |
object | ||
device.rememberedBrowser.browser |
string | ||
device.rememberedBrowser.generation |
number | ||
device.rememberedBrowser.issuedAt |
string | ||
device.rememberedBrowser.secondFactorAt |
string | ||
device.riskChange |
object | ||
device.riskChange.actor |
string | ||
device.riskChange.at |
string | ||
device.riskChange.beforeCompromise |
string | ||
device.riskChange.level |
string | ||
device.riskChange.previous |
string, or null | ||
device.riskChange.reason |
string | ||
device.riskChange.source |
string | ||
device.riskLevel |
string | ||
device.sessionLive |
boolean | ||
device.status |
string | ||
device.statusChange |
object | ||
device.statusChange.actor |
string | ||
device.statusChange.at |
string | ||
device.statusChange.previous |
string, or null | ||
device.statusChange.reason |
string | ||
device.statusChange.source |
string | ||
device.statusChange.status |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
id |
string | ||
key |
string | The key’s id. | |
message |
string | ||
ok |
boolean | yes | |
previous |
string | ||
sessionsEnded |
number | ||
status |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
certificatesRevoked |
number | ||
device |
object | ||
device.applicationNames |
list | ||
device.applicationNames[] |
string | ||
device.applications |
list | ||
device.applications[] |
string | ||
device.attestation |
object | ||
device.attestation.format |
string | ||
device.attestation.keyId |
string | ||
device.attestation.level |
string | ||
device.attestation.summary |
string | ||
device.compliance |
string | ||
device.complianceChange |
object | ||
device.complianceChange.actor |
string | ||
device.complianceChange.at |
string | ||
device.complianceChange.previous |
string, or null | ||
device.complianceChange.reason |
string | ||
device.complianceChange.source |
string | ||
device.complianceChange.status |
string | ||
device.created |
string | ||
device.dn |
string | ||
device.enrolment |
object | ||
device.enrolment.actor |
string | ||
device.enrolment.at |
string | ||
device.enrolment.method |
string | ||
device.id |
string | ||
device.keyKinds |
list | ||
device.keyKinds[] |
string | ||
device.keys |
list | ||
device.keys[].added |
string | ||
device.keys[].addedBy |
string | ||
device.keys[].attestation |
object | ||
device.keys[].attestation.chainSerials |
list | ||
device.keys[].attestation.chainSerials[] |
string | ||
device.keys[].attestation.format |
string | ||
device.keys[].attestation.freshness |
object | ||
device.keys[].attestation.freshness.detail |
string | ||
device.keys[].attestation.freshness.status |
string | ||
device.keys[].attestation.level |
string | ||
device.keys[].attestation.revocation |
object | ||
device.keys[].attestation.revocation.chainSerials |
list | ||
device.keys[].attestation.revocation.chainSerials[] |
string | ||
device.keys[].attestation.revocation.checkedAt |
string, or number | ||
device.keys[].attestation.revocation.listVersion |
string | ||
device.keys[].attestation.revocation.reason |
string | ||
device.keys[].attestation.revocation.serial |
string | ||
device.keys[].attestation.revocation.status |
string | ||
device.keys[].attestation.revocation.why |
string | ||
device.keys[].attestation.summary |
string | ||
device.keys[].attestation.verifiedAt |
string | ||
device.keys[].id |
string | ||
device.keys[].kind |
string | ||
device.keys[].label |
string | ||
device.keys[].material |
object | ||
device.keys[].material.aaguid |
string | ||
device.keys[].material.attachment |
string | ||
device.keys[].material.certificate |
string | ||
device.keys[].material.credentialId |
string | ||
device.keys[].material.issuer |
string, or null | ||
device.keys[].material.jwk |
map | A public JWK’s members. | |
device.keys[].material.jwk.{key} |
list, or string, or boolean, or number | ||
device.keys[].material.jwk.{key}[] |
string | ||
device.keys[].material.notAfter |
string, or number, or null | ||
device.keys[].material.serial |
string, or null | ||
device.keys[].material.subject |
string, or null | ||
device.keys[].proof |
string | ||
device.keys[].thumbprint |
string | ||
device.label |
string | ||
device.lastUsed |
string | ||
device.model |
string | ||
device.nativeSso |
boolean | ||
device.os |
string | ||
device.owner |
string | ||
device.ownerFound |
boolean | ||
device.ownerKind |
string | ||
device.ownerName |
string | ||
device.platform |
string | ||
device.rememberedBrowser |
object | ||
device.rememberedBrowser.browser |
string | ||
device.rememberedBrowser.generation |
number | ||
device.rememberedBrowser.issuedAt |
string | ||
device.rememberedBrowser.secondFactorAt |
string | ||
device.riskChange |
object | ||
device.riskChange.actor |
string | ||
device.riskChange.at |
string | ||
device.riskChange.beforeCompromise |
string | ||
device.riskChange.level |
string | ||
device.riskChange.previous |
string, or null | ||
device.riskChange.reason |
string | ||
device.riskChange.source |
string | ||
device.riskLevel |
string | ||
device.sessionLive |
boolean | ||
device.status |
string | ||
device.statusChange |
object | ||
device.statusChange.actor |
string | ||
device.statusChange.at |
string | ||
device.statusChange.previous |
string, or null | ||
device.statusChange.reason |
string | ||
device.statusChange.source |
string | ||
device.statusChange.status |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
id |
string | ||
key |
string | The key’s id. | |
message |
string | ||
ok |
boolean | yes | |
previous |
string | ||
sessionsEnded |
number | ||
status |
string |
POST /admin-api/devices/set-compliance
setDeviceCompliance
Set a device’s compliance, as an administrator
status is compliant, not-compliant or unknown (withdrawing a vouch), with an optional reason. Recorded with source admin. When what a receiver can be told moved — CAEP knows compliant and not-compliant, and unknown is sent as not-compliant — a CAEP device-compliance-change goes out, its subject the device and its owner. An MDM feed reports through POST /admin-api/device-compliance instead, under its own scope. Refused for an unknown device (STS-DEVICE-0007) or status (STS-DEVICE-0011).
Mirrors POST /admin/devices 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 device id. |
reason |
string | ||
status |
one of compliant, not-compliant, unknown |
yes |
200: The device, its previous and new status.
| Member | Type | Required | What it is |
|---|---|---|---|
certificatesRevoked |
number | ||
device |
object | ||
device.applicationNames |
list | ||
device.applicationNames[] |
string | ||
device.applications |
list | ||
device.applications[] |
string | ||
device.attestation |
object | ||
device.attestation.format |
string | ||
device.attestation.keyId |
string | ||
device.attestation.level |
string | ||
device.attestation.summary |
string | ||
device.compliance |
string | ||
device.complianceChange |
object | ||
device.complianceChange.actor |
string | ||
device.complianceChange.at |
string | ||
device.complianceChange.previous |
string, or null | ||
device.complianceChange.reason |
string | ||
device.complianceChange.source |
string | ||
device.complianceChange.status |
string | ||
device.created |
string | ||
device.dn |
string | ||
device.enrolment |
object | ||
device.enrolment.actor |
string | ||
device.enrolment.at |
string | ||
device.enrolment.method |
string | ||
device.id |
string | ||
device.keyKinds |
list | ||
device.keyKinds[] |
string | ||
device.keys |
list | ||
device.keys[].added |
string | ||
device.keys[].addedBy |
string | ||
device.keys[].attestation |
object | ||
device.keys[].attestation.chainSerials |
list | ||
device.keys[].attestation.chainSerials[] |
string | ||
device.keys[].attestation.format |
string | ||
device.keys[].attestation.freshness |
object | ||
device.keys[].attestation.freshness.detail |
string | ||
device.keys[].attestation.freshness.status |
string | ||
device.keys[].attestation.level |
string | ||
device.keys[].attestation.revocation |
object | ||
device.keys[].attestation.revocation.chainSerials |
list | ||
device.keys[].attestation.revocation.chainSerials[] |
string | ||
device.keys[].attestation.revocation.checkedAt |
string, or number | ||
device.keys[].attestation.revocation.listVersion |
string | ||
device.keys[].attestation.revocation.reason |
string | ||
device.keys[].attestation.revocation.serial |
string | ||
device.keys[].attestation.revocation.status |
string | ||
device.keys[].attestation.revocation.why |
string | ||
device.keys[].attestation.summary |
string | ||
device.keys[].attestation.verifiedAt |
string | ||
device.keys[].id |
string | ||
device.keys[].kind |
string | ||
device.keys[].label |
string | ||
device.keys[].material |
object | ||
device.keys[].material.aaguid |
string | ||
device.keys[].material.attachment |
string | ||
device.keys[].material.certificate |
string | ||
device.keys[].material.credentialId |
string | ||
device.keys[].material.issuer |
string, or null | ||
device.keys[].material.jwk |
map | A public JWK’s members. | |
device.keys[].material.jwk.{key} |
list, or string, or boolean, or number | ||
device.keys[].material.jwk.{key}[] |
string | ||
device.keys[].material.notAfter |
string, or number, or null | ||
device.keys[].material.serial |
string, or null | ||
device.keys[].material.subject |
string, or null | ||
device.keys[].proof |
string | ||
device.keys[].thumbprint |
string | ||
device.label |
string | ||
device.lastUsed |
string | ||
device.model |
string | ||
device.nativeSso |
boolean | ||
device.os |
string | ||
device.owner |
string | ||
device.ownerFound |
boolean | ||
device.ownerKind |
string | ||
device.ownerName |
string | ||
device.platform |
string | ||
device.rememberedBrowser |
object | ||
device.rememberedBrowser.browser |
string | ||
device.rememberedBrowser.generation |
number | ||
device.rememberedBrowser.issuedAt |
string | ||
device.rememberedBrowser.secondFactorAt |
string | ||
device.riskChange |
object | ||
device.riskChange.actor |
string | ||
device.riskChange.at |
string | ||
device.riskChange.beforeCompromise |
string | ||
device.riskChange.level |
string | ||
device.riskChange.previous |
string, or null | ||
device.riskChange.reason |
string | ||
device.riskChange.source |
string | ||
device.riskLevel |
string | ||
device.sessionLive |
boolean | ||
device.status |
string | ||
device.statusChange |
object | ||
device.statusChange.actor |
string | ||
device.statusChange.at |
string | ||
device.statusChange.previous |
string, or null | ||
device.statusChange.reason |
string | ||
device.statusChange.source |
string | ||
device.statusChange.status |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
id |
string | ||
key |
string | The key’s id. | |
message |
string | ||
ok |
boolean | yes | |
previous |
string | ||
sessionsEnded |
number | ||
status |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
certificatesRevoked |
number | ||
device |
object | ||
device.applicationNames |
list | ||
device.applicationNames[] |
string | ||
device.applications |
list | ||
device.applications[] |
string | ||
device.attestation |
object | ||
device.attestation.format |
string | ||
device.attestation.keyId |
string | ||
device.attestation.level |
string | ||
device.attestation.summary |
string | ||
device.compliance |
string | ||
device.complianceChange |
object | ||
device.complianceChange.actor |
string | ||
device.complianceChange.at |
string | ||
device.complianceChange.previous |
string, or null | ||
device.complianceChange.reason |
string | ||
device.complianceChange.source |
string | ||
device.complianceChange.status |
string | ||
device.created |
string | ||
device.dn |
string | ||
device.enrolment |
object | ||
device.enrolment.actor |
string | ||
device.enrolment.at |
string | ||
device.enrolment.method |
string | ||
device.id |
string | ||
device.keyKinds |
list | ||
device.keyKinds[] |
string | ||
device.keys |
list | ||
device.keys[].added |
string | ||
device.keys[].addedBy |
string | ||
device.keys[].attestation |
object | ||
device.keys[].attestation.chainSerials |
list | ||
device.keys[].attestation.chainSerials[] |
string | ||
device.keys[].attestation.format |
string | ||
device.keys[].attestation.freshness |
object | ||
device.keys[].attestation.freshness.detail |
string | ||
device.keys[].attestation.freshness.status |
string | ||
device.keys[].attestation.level |
string | ||
device.keys[].attestation.revocation |
object | ||
device.keys[].attestation.revocation.chainSerials |
list | ||
device.keys[].attestation.revocation.chainSerials[] |
string | ||
device.keys[].attestation.revocation.checkedAt |
string, or number | ||
device.keys[].attestation.revocation.listVersion |
string | ||
device.keys[].attestation.revocation.reason |
string | ||
device.keys[].attestation.revocation.serial |
string | ||
device.keys[].attestation.revocation.status |
string | ||
device.keys[].attestation.revocation.why |
string | ||
device.keys[].attestation.summary |
string | ||
device.keys[].attestation.verifiedAt |
string | ||
device.keys[].id |
string | ||
device.keys[].kind |
string | ||
device.keys[].label |
string | ||
device.keys[].material |
object | ||
device.keys[].material.aaguid |
string | ||
device.keys[].material.attachment |
string | ||
device.keys[].material.certificate |
string | ||
device.keys[].material.credentialId |
string | ||
device.keys[].material.issuer |
string, or null | ||
device.keys[].material.jwk |
map | A public JWK’s members. | |
device.keys[].material.jwk.{key} |
list, or string, or boolean, or number | ||
device.keys[].material.jwk.{key}[] |
string | ||
device.keys[].material.notAfter |
string, or number, or null | ||
device.keys[].material.serial |
string, or null | ||
device.keys[].material.subject |
string, or null | ||
device.keys[].proof |
string | ||
device.keys[].thumbprint |
string | ||
device.label |
string | ||
device.lastUsed |
string | ||
device.model |
string | ||
device.nativeSso |
boolean | ||
device.os |
string | ||
device.owner |
string | ||
device.ownerFound |
boolean | ||
device.ownerKind |
string | ||
device.ownerName |
string | ||
device.platform |
string | ||
device.rememberedBrowser |
object | ||
device.rememberedBrowser.browser |
string | ||
device.rememberedBrowser.generation |
number | ||
device.rememberedBrowser.issuedAt |
string | ||
device.rememberedBrowser.secondFactorAt |
string | ||
device.riskChange |
object | ||
device.riskChange.actor |
string | ||
device.riskChange.at |
string | ||
device.riskChange.beforeCompromise |
string | ||
device.riskChange.level |
string | ||
device.riskChange.previous |
string, or null | ||
device.riskChange.reason |
string | ||
device.riskChange.source |
string | ||
device.riskLevel |
string | ||
device.sessionLive |
boolean | ||
device.status |
string | ||
device.statusChange |
object | ||
device.statusChange.actor |
string | ||
device.statusChange.at |
string | ||
device.statusChange.previous |
string, or null | ||
device.statusChange.reason |
string | ||
device.statusChange.source |
string | ||
device.statusChange.status |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
id |
string | ||
key |
string | The key’s id. | |
message |
string | ||
ok |
boolean | yes | |
previous |
string | ||
sessionsEnded |
number | ||
status |
string |
POST /admin-api/devices/set-status
setDeviceStatus
Mark a device compromised, or restore it
status compromised: every sign-on session one of its keys authenticated is ended, its Native SSO secret revoked, every certificate this service’s EST or SCEP Issuing CA issued it revoked for keyCompromise, its risk level raised to HIGH (CAEP risk-level-change, principal DEVICE), and for a person’s device RISC credential-compromise is sent naming the person and the device (and the deprecated sessions-revoked, where risc.autoEmitTypes names it). active restores it and puts back the risk level the compromise raised; nothing revoked comes back. Answers sessionsEnded and certificatesRevoked.
Mirrors POST /admin/devices 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 device id. |
reason |
string | ||
status |
one of active, compromised |
yes |
200: The device, and what the compromise ended and revoked.
| Member | Type | Required | What it is |
|---|---|---|---|
certificatesRevoked |
number | ||
device |
object | ||
device.applicationNames |
list | ||
device.applicationNames[] |
string | ||
device.applications |
list | ||
device.applications[] |
string | ||
device.attestation |
object | ||
device.attestation.format |
string | ||
device.attestation.keyId |
string | ||
device.attestation.level |
string | ||
device.attestation.summary |
string | ||
device.compliance |
string | ||
device.complianceChange |
object | ||
device.complianceChange.actor |
string | ||
device.complianceChange.at |
string | ||
device.complianceChange.previous |
string, or null | ||
device.complianceChange.reason |
string | ||
device.complianceChange.source |
string | ||
device.complianceChange.status |
string | ||
device.created |
string | ||
device.dn |
string | ||
device.enrolment |
object | ||
device.enrolment.actor |
string | ||
device.enrolment.at |
string | ||
device.enrolment.method |
string | ||
device.id |
string | ||
device.keyKinds |
list | ||
device.keyKinds[] |
string | ||
device.keys |
list | ||
device.keys[].added |
string | ||
device.keys[].addedBy |
string | ||
device.keys[].attestation |
object | ||
device.keys[].attestation.chainSerials |
list | ||
device.keys[].attestation.chainSerials[] |
string | ||
device.keys[].attestation.format |
string | ||
device.keys[].attestation.freshness |
object | ||
device.keys[].attestation.freshness.detail |
string | ||
device.keys[].attestation.freshness.status |
string | ||
device.keys[].attestation.level |
string | ||
device.keys[].attestation.revocation |
object | ||
device.keys[].attestation.revocation.chainSerials |
list | ||
device.keys[].attestation.revocation.chainSerials[] |
string | ||
device.keys[].attestation.revocation.checkedAt |
string, or number | ||
device.keys[].attestation.revocation.listVersion |
string | ||
device.keys[].attestation.revocation.reason |
string | ||
device.keys[].attestation.revocation.serial |
string | ||
device.keys[].attestation.revocation.status |
string | ||
device.keys[].attestation.revocation.why |
string | ||
device.keys[].attestation.summary |
string | ||
device.keys[].attestation.verifiedAt |
string | ||
device.keys[].id |
string | ||
device.keys[].kind |
string | ||
device.keys[].label |
string | ||
device.keys[].material |
object | ||
device.keys[].material.aaguid |
string | ||
device.keys[].material.attachment |
string | ||
device.keys[].material.certificate |
string | ||
device.keys[].material.credentialId |
string | ||
device.keys[].material.issuer |
string, or null | ||
device.keys[].material.jwk |
map | A public JWK’s members. | |
device.keys[].material.jwk.{key} |
list, or string, or boolean, or number | ||
device.keys[].material.jwk.{key}[] |
string | ||
device.keys[].material.notAfter |
string, or number, or null | ||
device.keys[].material.serial |
string, or null | ||
device.keys[].material.subject |
string, or null | ||
device.keys[].proof |
string | ||
device.keys[].thumbprint |
string | ||
device.label |
string | ||
device.lastUsed |
string | ||
device.model |
string | ||
device.nativeSso |
boolean | ||
device.os |
string | ||
device.owner |
string | ||
device.ownerFound |
boolean | ||
device.ownerKind |
string | ||
device.ownerName |
string | ||
device.platform |
string | ||
device.rememberedBrowser |
object | ||
device.rememberedBrowser.browser |
string | ||
device.rememberedBrowser.generation |
number | ||
device.rememberedBrowser.issuedAt |
string | ||
device.rememberedBrowser.secondFactorAt |
string | ||
device.riskChange |
object | ||
device.riskChange.actor |
string | ||
device.riskChange.at |
string | ||
device.riskChange.beforeCompromise |
string | ||
device.riskChange.level |
string | ||
device.riskChange.previous |
string, or null | ||
device.riskChange.reason |
string | ||
device.riskChange.source |
string | ||
device.riskLevel |
string | ||
device.sessionLive |
boolean | ||
device.status |
string | ||
device.statusChange |
object | ||
device.statusChange.actor |
string | ||
device.statusChange.at |
string | ||
device.statusChange.previous |
string, or null | ||
device.statusChange.reason |
string | ||
device.statusChange.source |
string | ||
device.statusChange.status |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
id |
string | ||
key |
string | The key’s id. | |
message |
string | ||
ok |
boolean | yes | |
previous |
string | ||
sessionsEnded |
number | ||
status |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
certificatesRevoked |
number | ||
device |
object | ||
device.applicationNames |
list | ||
device.applicationNames[] |
string | ||
device.applications |
list | ||
device.applications[] |
string | ||
device.attestation |
object | ||
device.attestation.format |
string | ||
device.attestation.keyId |
string | ||
device.attestation.level |
string | ||
device.attestation.summary |
string | ||
device.compliance |
string | ||
device.complianceChange |
object | ||
device.complianceChange.actor |
string | ||
device.complianceChange.at |
string | ||
device.complianceChange.previous |
string, or null | ||
device.complianceChange.reason |
string | ||
device.complianceChange.source |
string | ||
device.complianceChange.status |
string | ||
device.created |
string | ||
device.dn |
string | ||
device.enrolment |
object | ||
device.enrolment.actor |
string | ||
device.enrolment.at |
string | ||
device.enrolment.method |
string | ||
device.id |
string | ||
device.keyKinds |
list | ||
device.keyKinds[] |
string | ||
device.keys |
list | ||
device.keys[].added |
string | ||
device.keys[].addedBy |
string | ||
device.keys[].attestation |
object | ||
device.keys[].attestation.chainSerials |
list | ||
device.keys[].attestation.chainSerials[] |
string | ||
device.keys[].attestation.format |
string | ||
device.keys[].attestation.freshness |
object | ||
device.keys[].attestation.freshness.detail |
string | ||
device.keys[].attestation.freshness.status |
string | ||
device.keys[].attestation.level |
string | ||
device.keys[].attestation.revocation |
object | ||
device.keys[].attestation.revocation.chainSerials |
list | ||
device.keys[].attestation.revocation.chainSerials[] |
string | ||
device.keys[].attestation.revocation.checkedAt |
string, or number | ||
device.keys[].attestation.revocation.listVersion |
string | ||
device.keys[].attestation.revocation.reason |
string | ||
device.keys[].attestation.revocation.serial |
string | ||
device.keys[].attestation.revocation.status |
string | ||
device.keys[].attestation.revocation.why |
string | ||
device.keys[].attestation.summary |
string | ||
device.keys[].attestation.verifiedAt |
string | ||
device.keys[].id |
string | ||
device.keys[].kind |
string | ||
device.keys[].label |
string | ||
device.keys[].material |
object | ||
device.keys[].material.aaguid |
string | ||
device.keys[].material.attachment |
string | ||
device.keys[].material.certificate |
string | ||
device.keys[].material.credentialId |
string | ||
device.keys[].material.issuer |
string, or null | ||
device.keys[].material.jwk |
map | A public JWK’s members. | |
device.keys[].material.jwk.{key} |
list, or string, or boolean, or number | ||
device.keys[].material.jwk.{key}[] |
string | ||
device.keys[].material.notAfter |
string, or number, or null | ||
device.keys[].material.serial |
string, or null | ||
device.keys[].material.subject |
string, or null | ||
device.keys[].proof |
string | ||
device.keys[].thumbprint |
string | ||
device.label |
string | ||
device.lastUsed |
string | ||
device.model |
string | ||
device.nativeSso |
boolean | ||
device.os |
string | ||
device.owner |
string | ||
device.ownerFound |
boolean | ||
device.ownerKind |
string | ||
device.ownerName |
string | ||
device.platform |
string | ||
device.rememberedBrowser |
object | ||
device.rememberedBrowser.browser |
string | ||
device.rememberedBrowser.generation |
number | ||
device.rememberedBrowser.issuedAt |
string | ||
device.rememberedBrowser.secondFactorAt |
string | ||
device.riskChange |
object | ||
device.riskChange.actor |
string | ||
device.riskChange.at |
string | ||
device.riskChange.beforeCompromise |
string | ||
device.riskChange.level |
string | ||
device.riskChange.previous |
string, or null | ||
device.riskChange.reason |
string | ||
device.riskChange.source |
string | ||
device.riskLevel |
string | ||
device.sessionLive |
boolean | ||
device.status |
string | ||
device.statusChange |
object | ||
device.statusChange.actor |
string | ||
device.statusChange.at |
string | ||
device.statusChange.previous |
string, or null | ||
device.statusChange.reason |
string | ||
device.statusChange.source |
string | ||
device.statusChange.status |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
id |
string | ||
key |
string | The key’s id. | |
message |
string | ||
ok |
boolean | yes | |
previous |
string | ||
sessionsEnded |
number | ||
status |
string |
POST /admin-api/devices/update
updateDevice
Change a device’s label, owner or description
Any of label, platform, model, os, applications (the whole list) and a new owner (with ownerKind). A new owner is held to its own bound and takes the device WITHOUT its Native SSO secret, which was bound to the old owner’s session; its keys go with it. Refused for an unknown device (STS-DEVICE-0007).
Mirrors POST /admin/devices 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 |
|---|---|---|---|
applications |
any JSON | The whole list, as on create. | |
id |
string | yes | The device id. |
label |
string | ||
model |
string | ||
os |
string | ||
owner |
string | ||
ownerKind |
one of person, application |
||
platform |
string |
200: The device as saved, and what changed.
| Member | Type | Required | What it is |
|---|---|---|---|
certificatesRevoked |
number | ||
device |
object | ||
device.applicationNames |
list | ||
device.applicationNames[] |
string | ||
device.applications |
list | ||
device.applications[] |
string | ||
device.attestation |
object | ||
device.attestation.format |
string | ||
device.attestation.keyId |
string | ||
device.attestation.level |
string | ||
device.attestation.summary |
string | ||
device.compliance |
string | ||
device.complianceChange |
object | ||
device.complianceChange.actor |
string | ||
device.complianceChange.at |
string | ||
device.complianceChange.previous |
string, or null | ||
device.complianceChange.reason |
string | ||
device.complianceChange.source |
string | ||
device.complianceChange.status |
string | ||
device.created |
string | ||
device.dn |
string | ||
device.enrolment |
object | ||
device.enrolment.actor |
string | ||
device.enrolment.at |
string | ||
device.enrolment.method |
string | ||
device.id |
string | ||
device.keyKinds |
list | ||
device.keyKinds[] |
string | ||
device.keys |
list | ||
device.keys[].added |
string | ||
device.keys[].addedBy |
string | ||
device.keys[].attestation |
object | ||
device.keys[].attestation.chainSerials |
list | ||
device.keys[].attestation.chainSerials[] |
string | ||
device.keys[].attestation.format |
string | ||
device.keys[].attestation.freshness |
object | ||
device.keys[].attestation.freshness.detail |
string | ||
device.keys[].attestation.freshness.status |
string | ||
device.keys[].attestation.level |
string | ||
device.keys[].attestation.revocation |
object | ||
device.keys[].attestation.revocation.chainSerials |
list | ||
device.keys[].attestation.revocation.chainSerials[] |
string | ||
device.keys[].attestation.revocation.checkedAt |
string, or number | ||
device.keys[].attestation.revocation.listVersion |
string | ||
device.keys[].attestation.revocation.reason |
string | ||
device.keys[].attestation.revocation.serial |
string | ||
device.keys[].attestation.revocation.status |
string | ||
device.keys[].attestation.revocation.why |
string | ||
device.keys[].attestation.summary |
string | ||
device.keys[].attestation.verifiedAt |
string | ||
device.keys[].id |
string | ||
device.keys[].kind |
string | ||
device.keys[].label |
string | ||
device.keys[].material |
object | ||
device.keys[].material.aaguid |
string | ||
device.keys[].material.attachment |
string | ||
device.keys[].material.certificate |
string | ||
device.keys[].material.credentialId |
string | ||
device.keys[].material.issuer |
string, or null | ||
device.keys[].material.jwk |
map | A public JWK’s members. | |
device.keys[].material.jwk.{key} |
list, or string, or boolean, or number | ||
device.keys[].material.jwk.{key}[] |
string | ||
device.keys[].material.notAfter |
string, or number, or null | ||
device.keys[].material.serial |
string, or null | ||
device.keys[].material.subject |
string, or null | ||
device.keys[].proof |
string | ||
device.keys[].thumbprint |
string | ||
device.label |
string | ||
device.lastUsed |
string | ||
device.model |
string | ||
device.nativeSso |
boolean | ||
device.os |
string | ||
device.owner |
string | ||
device.ownerFound |
boolean | ||
device.ownerKind |
string | ||
device.ownerName |
string | ||
device.platform |
string | ||
device.rememberedBrowser |
object | ||
device.rememberedBrowser.browser |
string | ||
device.rememberedBrowser.generation |
number | ||
device.rememberedBrowser.issuedAt |
string | ||
device.rememberedBrowser.secondFactorAt |
string | ||
device.riskChange |
object | ||
device.riskChange.actor |
string | ||
device.riskChange.at |
string | ||
device.riskChange.beforeCompromise |
string | ||
device.riskChange.level |
string | ||
device.riskChange.previous |
string, or null | ||
device.riskChange.reason |
string | ||
device.riskChange.source |
string | ||
device.riskLevel |
string | ||
device.sessionLive |
boolean | ||
device.status |
string | ||
device.statusChange |
object | ||
device.statusChange.actor |
string | ||
device.statusChange.at |
string | ||
device.statusChange.previous |
string, or null | ||
device.statusChange.reason |
string | ||
device.statusChange.source |
string | ||
device.statusChange.status |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
id |
string | ||
key |
string | The key’s id. | |
message |
string | ||
ok |
boolean | yes | |
previous |
string | ||
sessionsEnded |
number | ||
status |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
certificatesRevoked |
number | ||
device |
object | ||
device.applicationNames |
list | ||
device.applicationNames[] |
string | ||
device.applications |
list | ||
device.applications[] |
string | ||
device.attestation |
object | ||
device.attestation.format |
string | ||
device.attestation.keyId |
string | ||
device.attestation.level |
string | ||
device.attestation.summary |
string | ||
device.compliance |
string | ||
device.complianceChange |
object | ||
device.complianceChange.actor |
string | ||
device.complianceChange.at |
string | ||
device.complianceChange.previous |
string, or null | ||
device.complianceChange.reason |
string | ||
device.complianceChange.source |
string | ||
device.complianceChange.status |
string | ||
device.created |
string | ||
device.dn |
string | ||
device.enrolment |
object | ||
device.enrolment.actor |
string | ||
device.enrolment.at |
string | ||
device.enrolment.method |
string | ||
device.id |
string | ||
device.keyKinds |
list | ||
device.keyKinds[] |
string | ||
device.keys |
list | ||
device.keys[].added |
string | ||
device.keys[].addedBy |
string | ||
device.keys[].attestation |
object | ||
device.keys[].attestation.chainSerials |
list | ||
device.keys[].attestation.chainSerials[] |
string | ||
device.keys[].attestation.format |
string | ||
device.keys[].attestation.freshness |
object | ||
device.keys[].attestation.freshness.detail |
string | ||
device.keys[].attestation.freshness.status |
string | ||
device.keys[].attestation.level |
string | ||
device.keys[].attestation.revocation |
object | ||
device.keys[].attestation.revocation.chainSerials |
list | ||
device.keys[].attestation.revocation.chainSerials[] |
string | ||
device.keys[].attestation.revocation.checkedAt |
string, or number | ||
device.keys[].attestation.revocation.listVersion |
string | ||
device.keys[].attestation.revocation.reason |
string | ||
device.keys[].attestation.revocation.serial |
string | ||
device.keys[].attestation.revocation.status |
string | ||
device.keys[].attestation.revocation.why |
string | ||
device.keys[].attestation.summary |
string | ||
device.keys[].attestation.verifiedAt |
string | ||
device.keys[].id |
string | ||
device.keys[].kind |
string | ||
device.keys[].label |
string | ||
device.keys[].material |
object | ||
device.keys[].material.aaguid |
string | ||
device.keys[].material.attachment |
string | ||
device.keys[].material.certificate |
string | ||
device.keys[].material.credentialId |
string | ||
device.keys[].material.issuer |
string, or null | ||
device.keys[].material.jwk |
map | A public JWK’s members. | |
device.keys[].material.jwk.{key} |
list, or string, or boolean, or number | ||
device.keys[].material.jwk.{key}[] |
string | ||
device.keys[].material.notAfter |
string, or number, or null | ||
device.keys[].material.serial |
string, or null | ||
device.keys[].material.subject |
string, or null | ||
device.keys[].proof |
string | ||
device.keys[].thumbprint |
string | ||
device.label |
string | ||
device.lastUsed |
string | ||
device.model |
string | ||
device.nativeSso |
boolean | ||
device.os |
string | ||
device.owner |
string | ||
device.ownerFound |
boolean | ||
device.ownerKind |
string | ||
device.ownerName |
string | ||
device.platform |
string | ||
device.rememberedBrowser |
object | ||
device.rememberedBrowser.browser |
string | ||
device.rememberedBrowser.generation |
number | ||
device.rememberedBrowser.issuedAt |
string | ||
device.rememberedBrowser.secondFactorAt |
string | ||
device.riskChange |
object | ||
device.riskChange.actor |
string | ||
device.riskChange.at |
string | ||
device.riskChange.beforeCompromise |
string | ||
device.riskChange.level |
string | ||
device.riskChange.previous |
string, or null | ||
device.riskChange.reason |
string | ||
device.riskChange.source |
string | ||
device.riskLevel |
string | ||
device.sessionLive |
boolean | ||
device.status |
string | ||
device.statusChange |
object | ||
device.statusChange.actor |
string | ||
device.statusChange.at |
string | ||
device.statusChange.previous |
string, or null | ||
device.statusChange.reason |
string | ||
device.statusChange.source |
string | ||
device.statusChange.status |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
id |
string | ||
key |
string | The key’s id. | |
message |
string | ||
ok |
boolean | yes | |
previous |
string | ||
sessionsEnded |
number | ||
status |
string |