Who it has authenticated, and what each of them holds.
Every answer is checked against the model shown here before it is sent, and no answer carries a member its model does not list. A member shown as any JSON is one whose shape belongs to somebody else, and says whose. .{key} is a key that is data, and [] an element of a list.
A refusal
Unless an operation below says otherwise, any status it does not list answers this:
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | ||
status |
integer | ||
why |
string |
GET /admin-api/service-accounts
getServiceAccounts
Every service account and the state of its rotation
Every service account in this realm (#221) — a person entry carrying stsServiceAccount — paged in accounts, each with username, owners (each { dn, kind, name }, #600), destination, secretName, rotatedAt, previousPasswordUntil (the overlap) and rotation (rotates, nextDueAt, failures, lastError, lastAttemptAt, alarm), and the realm’s policy (rotationEnabled, intervalDays, overlapMinutes, alarmFailures, from) and totals (accounts, withDestination, rotating, failing, alarms). No password and no secret value is in the reply.
Mirrors GET /admin/service-accounts on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
failing |
query | one of true |
true: only accounts whose last rotation failed. |
|
account |
query | string | One service account, by username (#607): the answer is { found, account } alone — account as a row of accounts is, with ownerProtected — and an owner of the account may ask it with owner:read. |
|
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 accounts, the policy and the totals; or, with account, that one account.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
object | ||
account.destination |
string | ||
account.dn |
string | ||
account.ownerProtected |
boolean | ||
account.owners |
list | ||
account.owners[].dn |
string | ||
account.owners[].kind |
string | ||
account.owners[].name |
string | ||
account.owners[].present |
boolean | ||
account.policy |
string | ||
account.previousPasswordExpires |
number | ||
account.rotatedAt |
string | ||
account.rotation |
object | ||
account.rotation.failures |
number | ||
account.rotation.lastAttempt |
number | ||
account.rotation.lastError |
string | ||
account.secretName |
string | ||
account.serviceAccount |
boolean | ||
account.username |
string | ||
accounts |
list | ||
accounts[].destination |
string, or null | ||
accounts[].owners |
list | ||
accounts[].owners[].dn |
string | ||
accounts[].owners[].kind |
string | ||
accounts[].owners[].name |
string | ||
accounts[].owners[].present |
boolean | ||
accounts[].ownership |
object | ||
accounts[].ownership.kind |
string | ||
accounts[].ownership.marked |
boolean | ||
accounts[].ownership.name |
string | ||
accounts[].ownership.protected |
boolean | ||
accounts[].ownership.reasons |
list | ||
accounts[].ownership.reasons[] |
string | ||
accounts[].policy |
object | ||
accounts[].policy.allowBrowserSignIn |
boolean | ||
accounts[].policy.doors |
list | ||
accounts[].policy.doors[] |
string | ||
accounts[].policy.exemptFromSecondFactor |
boolean | ||
accounts[].policy.from |
string | ||
accounts[].policy.name |
string, or null | ||
accounts[].policy.requiresOwner |
boolean | ||
accounts[].previousPasswordUntil |
string, or null | ||
accounts[].rotatedAt |
string, or null | ||
accounts[].rotation |
object | ||
accounts[].rotation.alarm |
boolean | ||
accounts[].rotation.enabled |
boolean | ||
accounts[].rotation.failures |
number | ||
accounts[].rotation.lastAttemptAt |
string, or null | ||
accounts[].rotation.lastError |
string, or null | ||
accounts[].rotation.nextDueAt |
string, or null | ||
accounts[].rotation.rotates |
boolean | ||
accounts[].secretName |
string, or null | ||
accounts[].username |
string | ||
filter |
object | ||
filter.failing |
boolean | ||
found |
boolean | ||
paging |
object | ||
paging.firstRow |
integer | ||
paging.lastRow |
integer | ||
paging.noun |
string | ||
paging.page |
integer | ||
paging.pages |
integer | ||
paging.param |
string | ||
paging.perPage |
integer | ||
paging.total |
integer | ||
policy |
object | ||
policy.alarmFailures |
number | ||
policy.from |
string | ||
policy.intervalDays |
number | ||
policy.overlapMinutes |
number | ||
policy.rotationEnabled |
boolean | ||
totals |
object | ||
totals.accounts |
number | ||
totals.alarms |
number | ||
totals.failing |
number | ||
totals.rotating |
number | ||
totals.withDestination |
number |
400: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
GET /admin-api/users
getUsers
Everyone this service has authenticated, or one of them in full
Without user it is the list. With it, one identity: the names they were seen under, how they authenticated each time, every sign-on session they hold with the tokens issued ON each of those, and their LDAP entry. A name this service has never seen answers 200 with known: false rather than 404 — it is an answer about the identity, not about the route.
The identity is a QUERY PARAMETER and not a path segment on purpose: the identities here contain the characters a path is made of (a Kerberos service principal is HTTP/host, a subject is a urn:), so /users/HTTP/web.example.com would be a two-segment path naming nobody.
ONE PAGE PARAMETER IS NOT IN THE LIST BELOW, because its name is data: each session’s own token list is moved by session-<the session id>Page, so ?user=alice&session-8Qk3...Page=2 moves that block and no other, and each session in the reply answers with its own tokensPaging. It is named after the session rather than numbered so that the link still moves the same session after the list around it has changed, and it is paged at all because one browser session can hold most of the tokens this service remembers. OpenAPI cannot spell a parameter whose name is built at runtime, and a session-{id}Page in the list would generate a client that sends a literal {id} — so it is here in words instead.
The ?user= reply’s authenticationEvents (#955) are the audit log’s authentication attempts by this person, newest first, across every application and protocol: authentication, authentication.refused, session.refuse and session.refused. A row is this person’s when its actor, the name they presented, detail.sub or detail.presented is their name, a name they have been seen under, or their subject, exactly as spelled. Each row is an audit event. authenticationEventsMatched is how many, authenticationEventsPaging pages them under authenticationsPage, authenticationEventsKnownActors says which actors have a user page, and authenticationEventsLog says how full the audit log is. The member is not authentications: that one is the count. The list holds no more history than the audit log does, and nothing in it is a credential. Another process’s rows are read before this reply is built when user is set, the same wait GET /admin-api/audit makes.
THE LIST IS CAPPED AND THE COUNT IS NOT (#610). directoryPeople is how many people the realm’s directory defines, counted by the directory without listing them (null where it offers no count). The rows are at most scanLimit of those people — scanned of them read, capped true when the directory held more — united with everybody this service has seen, so known is the length of that list and never the size of the directory. directoryCounts is what the page’s tiles draw, over every person the directory defines, without listing them: people; signedInHere, those of them the register has seen authenticate (it keeps the most recent identities only), and neverSignedInHere, the rest; withSecond, withTotp, withKeys, primaryKeys, unreadable, withPassword, passwordOnly (a password and no second factor) and noWayIn (neither a password nor a sign-in key). Null where the directory offers no such count. factors, authenticatedHere and the factor filter stay the LIST’s. A client comparing this resource with SCIM’s totalResults reads directoryPeople, never known (#684).
THE COUNT HAS AN AGE (#684). directoryCountedAt is when this process’s directory counted directoryCounts (ISO 8601), and directoryCountsKeptFor the most seconds it keeps that count against another process’s committed writes — its own writes, and the ones it has applied, end it at once. Two requests answered by two workers inside that window may carry two figures. Both are null where the directory offers no count, and directoryCountsKeptFor is null where no other process can lag it (the directory in memory).
Mirrors GET /admin/users on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
user |
query | string | One identity, as the list’s key names them. Returns the drill-down instead of the list. |
|
q |
query | string | Substring of the identity key, case-insensitive. | |
protocol |
query | string | Only identities that authenticated through this protocol family. The list’s protocols member says which values there are; it is read off the data, so a family nobody has used is not offered. |
|
factor |
query | one of any, totp, key, none, unreadable |
Only people holding a second factor of this kind, as on GET /admin-api/mfa. | |
kind |
query | one of service, person |
service: only service accounts (person entries carrying stsServiceAccount); person: everybody else. Each row says which in serviceAccount, and serviceAccounts counts them over the whole list. |
|
authenticationsPage |
query | integer | Which page of authenticationEvents, on the ?user= reply only. Named rather than the bare page so it does not move the session list. The member is not authentications: that one is the count. |
|
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. | |
sessionsPage |
query | integer | Which page of sessions to return, answered by sessionsPaging. Sign-on session blocks, which default to 5 rather than 50 because each one carries a token list of its own. Only the sessions ON this page are in the reply. |
|
tokensOnEndedSessionsPage |
query | integer | Which page of tokensOnEndedSessions to return, answered by tokensOnEndedSessionsPaging. Tokens issued on a session this service no longer holds. |
|
tokensWithNoSessionPage |
query | integer | Which page of tokensWithNoSession to return, answered by tokensWithNoSessionPaging. Tokens issued with no browser session at all: the grants that never involve one. |
|
artifactsPage |
query | integer | Which page of artifacts to return, answered by artifactsPaging. SAML assertions, Kerberos tickets and credentials. |
|
authenticationHistoryPage |
query | integer | Which page of authenticationHistory to return, answered by authenticationHistoryPaging. How they authenticated (user.events), most recent first, ten a page by default (#1844). user.events is still the whole list. |
|
federationLinksPage |
query | integer | Which page of federationLinks to return, answered by federationLinksPaging. The federation partners’ subjects linked to this person (#109), each { link, relationship, issuer, subject, relationshipExists }. |
|
gnapGrantsPage |
query | integer | Which page of gnapGrants to return, answered by gnapGrantsPaging. The GNAP grants this person is the resource owner of (#432): each with its state, why it was finalized (finalization.reason: issued, revoked, rejected, expired), its rights, the tokens issued under it (label, format, expiry, state — never a value) and whether it can still be revoked, which POST /admin-api/gnap/revoke-grant does with user. gnapGrantsCells says what a multi-cell service’s list leaves out. |
|
umaPage |
query | integer | Which page of uma to return, answered by umaPaging. This person’s UMA 2.0 (#1195): resources they own, the shares in their document, the permissions they hold in live RPTs (held, which POST /admin-api/uma/revoke-rpt revokes) and the requests waiting for them (pending). Null where UMA is not loaded. |
|
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 list, or one identity.
| Member | Type | Required | What it is |
|---|---|---|---|
| (the answer) | one of 3 shapes | ||
(shape 1) |
object | Everyone this service has authenticated, united with at most scanLimit of the people the directory defines. |
|
(shape 1).authenticatedHere |
number | ||
(shape 1).capped |
boolean | ||
(shape 1).directoryCountedAt |
string, or null | ||
(shape 1).directoryCounts |
object | ||
(shape 1).directoryCounts.neverSignedInHere |
number, or null | ||
(shape 1).directoryCounts.noWayIn |
number | ||
(shape 1).directoryCounts.passwordOnly |
number | ||
(shape 1).directoryCounts.people |
number | ||
(shape 1).directoryCounts.primaryKeys |
number | ||
(shape 1).directoryCounts.signedInHere |
number, or null | ||
(shape 1).directoryCounts.unreadable |
number | ||
(shape 1).directoryCounts.withKeys |
number | ||
(shape 1).directoryCounts.withPassword |
number | ||
(shape 1).directoryCounts.withSecond |
number | ||
(shape 1).directoryCounts.withTotp |
number | ||
(shape 1).directoryCountsKeptFor |
number, or null | ||
(shape 1).directoryPeople |
number, or null | ||
(shape 1).factors |
object | ||
(shape 1).factors.noCredential |
number | ||
(shape 1).factors.passwordOnly |
number | ||
(shape 1).factors.primaryKeys |
number | ||
(shape 1).factors.unreadable |
number | ||
(shape 1).factors.withKeys |
number | ||
(shape 1).factors.withSecond |
number | ||
(shape 1).factors.withTotp |
number | ||
(shape 1).filter |
object | ||
(shape 1).filter.factor |
string, or null | ||
(shape 1).filter.kind |
string, or null | ||
(shape 1).filter.protocol |
string, or null | ||
(shape 1).filter.q |
string, or null | ||
(shape 1).firstRow |
integer | ||
(shape 1).known |
number | ||
(shape 1).lastRow |
integer | ||
(shape 1).matched |
number | ||
(shape 1).newUserContainer |
string | ||
(shape 1).page |
integer | ||
(shape 1).pages |
integer | ||
(shape 1).paging |
object | ||
(shape 1).paging.firstRow |
integer | ||
(shape 1).paging.lastRow |
integer | ||
(shape 1).paging.noun |
string | ||
(shape 1).paging.page |
integer | ||
(shape 1).paging.pages |
integer | ||
(shape 1).paging.param |
string | ||
(shape 1).paging.perPage |
integer | ||
(shape 1).paging.total |
integer | ||
(shape 1).perPage |
integer | ||
(shape 1).personFieldCount |
number | ||
(shape 1).protocols |
list | ||
(shape 1).protocols[] |
string | ||
(shape 1).registryCap |
number | ||
(shape 1).registryKeeps |
number | ||
(shape 1).scanLimit |
number | ||
(shape 1).scanned |
number | ||
(shape 1).serviceAccounts |
number | ||
(shape 1).shown |
number | ||
(shape 1).store |
boolean | ||
(shape 1).users |
list | ||
(shape 1).users[].artifactKinds |
list | ||
(shape 1).users[].artifactKinds[].count |
number | ||
(shape 1).users[].artifactKinds[].kind |
string | ||
(shape 1).users[].artifacts |
number | ||
(shape 1).users[].authenticated |
boolean | ||
(shape 1).users[].authentications |
number | ||
(shape 1).users[].dn |
string | ||
(shape 1).users[].events |
list | ||
(shape 1).users[].events[].acr |
string | ||
(shape 1).users[].events[].address |
string | ||
(shape 1).users[].events[].amr |
list, or string | ||
(shape 1).users[].events[].amr[] |
string | ||
(shape 1).users[].events[].at |
number | ||
(shape 1).users[].events[].client_id |
string | ||
(shape 1).users[].events[].method |
string | ||
(shape 1).users[].events[].note |
string | ||
(shape 1).users[].events[].presented |
string | ||
(shape 1).users[].events[].protocol |
string | ||
(shape 1).users[].events[].realm |
string | ||
(shape 1).users[].events[].sessionId |
string | ||
(shape 1).users[].events[].sub |
string | ||
(shape 1).users[].eventsForgotten |
number | ||
(shape 1).users[].factors |
object | ||
(shape 1).users[].factors.backupCodes |
object | ||
(shape 1).users[].factors.backupCodes.generatedAt |
number | ||
(shape 1).users[].factors.backupCodes.hashed |
boolean | ||
(shape 1).users[].factors.backupCodes.lastUsedAt |
number | ||
(shape 1).users[].factors.backupCodes.legacy |
boolean | ||
(shape 1).users[].factors.backupCodes.present |
boolean | ||
(shape 1).users[].factors.backupCodes.remaining |
number | ||
(shape 1).users[].factors.backupCodes.sealed |
boolean | ||
(shape 1).users[].factors.backupCodes.total |
number | ||
(shape 1).users[].factors.backupCodes.usable |
boolean | ||
(shape 1).users[].factors.backupCodes.used |
number | ||
(shape 1).users[].factors.backupCodes.why |
string | ||
(shape 1).users[].factors.inDirectory |
boolean | ||
(shape 1).users[].factors.known |
boolean | ||
(shape 1).users[].factors.mfaKeys |
number | ||
(shape 1).users[].factors.mfaRequired |
boolean | ||
(shape 1).users[].factors.password |
boolean | ||
(shape 1).users[].factors.primaryKeys |
number | ||
(shape 1).users[].factors.recoveryAdvised |
boolean | ||
(shape 1).users[].factors.secondFactor |
string, or null | ||
(shape 1).users[].factors.totp |
boolean | ||
(shape 1).users[].factors.totpDetail |
object | ||
(shape 1).users[].factors.totpDetail.algorithm |
string | ||
(shape 1).users[].factors.totpDetail.digits |
number | ||
(shape 1).users[].factors.totpDetail.enrolledAt |
number | ||
(shape 1).users[].factors.totpDetail.lastUsedAt |
number | ||
(shape 1).users[].factors.totpDetail.period |
number | ||
(shape 1).users[].factors.totpDetail.sealed |
boolean | ||
(shape 1).users[].factors.totpDetail.unusable |
boolean | ||
(shape 1).users[].factors.totpDetail.why |
string | ||
(shape 1).users[].factors.totpUsable |
boolean | ||
(shape 1).users[].factors.usable |
boolean | ||
(shape 1).users[].factors.username |
string | ||
(shape 1).users[].firstAt |
number | ||
(shape 1).users[].forms |
list | ||
(shape 1).users[].forms[].count |
number | ||
(shape 1).users[].forms[].form |
string | ||
(shape 1).users[].inDirectory |
boolean | ||
(shape 1).users[].isClient |
boolean | ||
(shape 1).users[].key |
string | ||
(shape 1).users[].knownBy |
string | ||
(shape 1).users[].lastActivityAt |
number | ||
(shape 1).users[].lastAt |
number | ||
(shape 1).users[].liveSessions |
number, or null | ||
(shape 1).users[].name |
string | ||
(shape 1).users[].protocols |
list | ||
(shape 1).users[].protocols[].count |
number | ||
(shape 1).users[].protocols[].firstAt |
number | ||
(shape 1).users[].protocols[].lastAt |
number | ||
(shape 1).users[].protocols[].methods |
list | ||
(shape 1).users[].protocols[].methods[].count |
number | ||
(shape 1).users[].protocols[].methods[].method |
string | ||
(shape 1).users[].protocols[].protocol |
string | ||
(shape 1).users[].realms |
list | ||
(shape 1).users[].realms[].count |
number | ||
(shape 1).users[].realms[].realm |
string | ||
(shape 1).users[].serviceAccount |
boolean | ||
(shape 1).users[].tokens |
object | ||
(shape 1).users[].tokens.expired |
number | ||
(shape 1).users[].tokens.issued |
number | ||
(shape 1).users[].tokens.other |
number | ||
(shape 1).users[].tokens.revoked |
number | ||
(shape 1).users[].tokens.valid |
number | ||
(shape 1).withActiveSession |
number, or null | ||
(shape 2) |
object | One identity: the names it has been seen under, how it authenticated, every sign-on session it holds with the tokens issued on each, and its directory entry. | |
(shape 2).artifacts |
list | ||
(shape 2).artifacts[].audience |
string | ||
(shape 2).artifacts[].claimSet |
string | ||
(shape 2).artifacts[].configId |
string | ||
(shape 2).artifacts[].entryId |
string | ||
(shape 2).artifacts[].etype |
string, or number | ||
(shape 2).artifacts[].expiresAt |
string, or number, or null | ||
(shape 2).artifacts[].hint |
string | ||
(shape 2).artifacts[].id |
string | ||
(shape 2).artifacts[].issuedAt |
number | ||
(shape 2).artifacts[].key |
string | ||
(shape 2).artifacts[].kind |
string | ||
(shape 2).artifacts[].pacClaims |
number | ||
(shape 2).artifacts[].person |
string | ||
(shape 2).artifacts[].realm |
string | ||
(shape 2).artifacts[].revoked |
boolean | ||
(shape 2).artifacts[].revokedAt |
number | ||
(shape 2).artifacts[].revokedVia |
string | ||
(shape 2).artifacts[].serial |
string | ||
(shape 2).artifacts[].service |
string | ||
(shape 2).artifacts[].signed |
boolean | ||
(shape 2).artifacts[].state |
string | ||
(shape 2).artifacts[].subject |
string | ||
(shape 2).artifacts[].username |
string | ||
(shape 2).artifactsPaging |
object | ||
(shape 2).artifactsPaging.firstRow |
integer | ||
(shape 2).artifactsPaging.lastRow |
integer | ||
(shape 2).artifactsPaging.noun |
string | ||
(shape 2).artifactsPaging.page |
integer | ||
(shape 2).artifactsPaging.pages |
integer | ||
(shape 2).artifactsPaging.param |
string | ||
(shape 2).artifactsPaging.perPage |
integer | ||
(shape 2).artifactsPaging.total |
integer | ||
(shape 2).attributeEditor |
object | ||
(shape 2).attributeEditor.attributes |
list | ||
(shape 2).attributeEditor.attributes[].choices |
list | ||
(shape 2).attributeEditor.attributes[].choices[] |
string | ||
(shape 2).attributeEditor.attributes[].custom |
boolean | ||
(shape 2).attributeEditor.attributes[].editable |
boolean | ||
(shape 2).attributeEditor.attributes[].example |
string | ||
(shape 2).attributeEditor.attributes[].format |
string | ||
(shape 2).attributeEditor.attributes[].group |
string | ||
(shape 2).attributeEditor.attributes[].label |
string | ||
(shape 2).attributeEditor.attributes[].multi |
boolean | ||
(shape 2).attributeEditor.attributes[].must |
boolean | ||
(shape 2).attributeEditor.attributes[].name |
string | ||
(shape 2).attributeEditor.attributes[].note |
string | ||
(shape 2).attributeEditor.attributes[].required |
boolean | ||
(shape 2).attributeEditor.attributes[].schema |
string | ||
(shape 2).attributeEditor.attributes[].simple |
boolean | ||
(shape 2).attributeEditor.attributes[].values |
list | ||
(shape 2).attributeEditor.attributes[].values[] |
string | ||
(shape 2).attributeEditor.attributes[].why |
string | ||
(shape 2).attributeEditor.dn |
string | ||
(shape 2).attributeEditor.mail |
string | ||
(shape 2).attributeEditor.pseudonymPending |
string | ||
(shape 2).attributeEditor.pseudonyms |
list | ||
(shape 2).attributeEditor.pseudonyms[] |
string | ||
(shape 2).attributeEditor.withheld |
list | ||
(shape 2).attributeEditor.withheld[].kind |
string | ||
(shape 2).attributeEditor.withheld[].label |
string | ||
(shape 2).attributeEditor.withheld[].name |
string | ||
(shape 2).attributeEditor.withheld[].why |
string | ||
(shape 2).authenticationEvents |
list | ||
(shape 2).authenticationEvents[].action |
string | ||
(shape 2).authenticationEvents[].actor |
string | ||
(shape 2).authenticationEvents[].actorForm |
string | ||
(shape 2).authenticationEvents[].address |
string | ||
(shape 2).authenticationEvents[].at |
number | ||
(shape 2).authenticationEvents[].category |
string | ||
(shape 2).authenticationEvents[].channel |
string | ||
(shape 2).authenticationEvents[].detail |
any JSON | What the call site that wrote the audit row chose to record, which differs at each of hundreds of them; the keys and the values are data. What the call site that wrote the audit row chose to record, which differs at each of hundreds of them; the keys and the values are data. | |
(shape 2).authenticationEvents[].errorCode |
string | ||
(shape 2).authenticationEvents[].mac |
string | ||
(shape 2).authenticationEvents[].origin |
string | ||
(shape 2).authenticationEvents[].outcome |
string | ||
(shape 2).authenticationEvents[].prev |
string | ||
(shape 2).authenticationEvents[].protocol |
string | ||
(shape 2).authenticationEvents[].seq |
number | ||
(shape 2).authenticationEvents[].summary |
string | ||
(shape 2).authenticationEvents[].target |
string | ||
(shape 2).authenticationEventsKnownActors |
map | ||
(shape 2).authenticationEventsKnownActors.{key} |
boolean | ||
(shape 2).authenticationEventsLog |
object | ||
(shape 2).authenticationEventsLog.dropped |
number | ||
(shape 2).authenticationEventsLog.held |
number | ||
(shape 2).authenticationEventsLog.maxEvents |
number | ||
(shape 2).authenticationEventsLog.recorded |
number | ||
(shape 2).authenticationEventsMatched |
number | ||
(shape 2).authenticationEventsPaging |
object | ||
(shape 2).authenticationEventsPaging.firstRow |
integer | ||
(shape 2).authenticationEventsPaging.lastRow |
integer | ||
(shape 2).authenticationEventsPaging.noun |
string | ||
(shape 2).authenticationEventsPaging.page |
integer | ||
(shape 2).authenticationEventsPaging.pages |
integer | ||
(shape 2).authenticationEventsPaging.param |
string | ||
(shape 2).authenticationEventsPaging.perPage |
integer | ||
(shape 2).authenticationEventsPaging.total |
integer | ||
(shape 2).authenticationHistory |
list | ||
(shape 2).authenticationHistory[].acr |
string | ||
(shape 2).authenticationHistory[].address |
string | ||
(shape 2).authenticationHistory[].amr |
list, or string | ||
(shape 2).authenticationHistory[].amr[] |
string | ||
(shape 2).authenticationHistory[].at |
number | ||
(shape 2).authenticationHistory[].client_id |
string | ||
(shape 2).authenticationHistory[].method |
string | ||
(shape 2).authenticationHistory[].note |
string | ||
(shape 2).authenticationHistory[].presented |
string | ||
(shape 2).authenticationHistory[].protocol |
string | ||
(shape 2).authenticationHistory[].realm |
string | ||
(shape 2).authenticationHistory[].sessionId |
string | ||
(shape 2).authenticationHistory[].sub |
string | ||
(shape 2).authenticationHistoryPaging |
object | ||
(shape 2).authenticationHistoryPaging.firstRow |
integer | ||
(shape 2).authenticationHistoryPaging.lastRow |
integer | ||
(shape 2).authenticationHistoryPaging.noun |
string | ||
(shape 2).authenticationHistoryPaging.page |
integer | ||
(shape 2).authenticationHistoryPaging.pages |
integer | ||
(shape 2).authenticationHistoryPaging.param |
string | ||
(shape 2).authenticationHistoryPaging.perPage |
integer | ||
(shape 2).authenticationHistoryPaging.total |
integer | ||
(shape 2).authenticationsWithoutActivity |
object | The authentications that start no sign-on session and issue nothing (a TLS client certificate on a request, an LDAP bind, a SCIM or SPIFFE caller’s credential), counted by protocol and method over the rows the Authentications tab lists (what the audit log still holds). Sessions & tokens draws its summary line from it; each one is on the Authentications tab. | |
(shape 2).authenticationsWithoutActivity.methods |
list | ||
(shape 2).authenticationsWithoutActivity.methods[].count |
integer | ||
(shape 2).authenticationsWithoutActivity.methods[].method |
string | ||
(shape 2).authenticationsWithoutActivity.methods[].protocol |
string | ||
(shape 2).authenticationsWithoutActivity.total |
integer | ||
(shape 2).credentials |
object | ||
(shape 2).credentials.caAvailable |
boolean | ||
(shape 2).credentials.found |
boolean | ||
(shape 2).credentials.keyPairs |
list | ||
(shape 2).credentials.keyPairs[].atCap |
boolean | ||
(shape 2).credentials.keyPairs[].attributes |
object | ||
(shape 2).credentials.keyPairs[].attributes.issuer |
string | ||
(shape 2).credentials.keyPairs[].attributes.keys |
string | ||
(shape 2).credentials.keyPairs[].attributes.privateKey |
string | ||
(shape 2).credentials.keyPairs[].effectiveIssuers |
list | ||
(shape 2).credentials.keyPairs[].effectiveIssuers[] |
string | ||
(shape 2).credentials.keyPairs[].handleLabel |
string | ||
(shape 2).credentials.keyPairs[].held |
boolean | ||
(shape 2).credentials.keyPairs[].issuers |
list | ||
(shape 2).credentials.keyPairs[].issuers[] |
string | ||
(shape 2).credentials.keyPairs[].keys |
list | ||
(shape 2).credentials.keyPairs[].keys[].certificate |
object | ||
(shape 2).credentials.keyPairs[].keys[].certificate.expired |
boolean | ||
(shape 2).credentials.keyPairs[].keys[].certificate.issuer |
string | ||
(shape 2).credentials.keyPairs[].keys[].certificate.keyType |
string | ||
(shape 2).credentials.keyPairs[].keys[].certificate.notAfter |
string | ||
(shape 2).credentials.keyPairs[].keys[].certificate.notBefore |
string | ||
(shape 2).credentials.keyPairs[].keys[].certificate.selfSigned |
boolean | ||
(shape 2).credentials.keyPairs[].keys[].certificate.serialHex |
string | ||
(shape 2).credentials.keyPairs[].keys[].certificate.subject |
string | ||
(shape 2).credentials.keyPairs[].keys[].certificate.thumbprint |
string | ||
(shape 2).credentials.keyPairs[].keys[].certificate.unreadable |
string | ||
(shape 2).credentials.keyPairs[].keys[].chain |
list | ||
(shape 2).credentials.keyPairs[].keys[].chain[].expired |
object | Nested deeper than this page draws. | |
(shape 2).credentials.keyPairs[].keys[].chain[].issuer |
object | Nested deeper than this page draws. | |
(shape 2).credentials.keyPairs[].keys[].chain[].keyType |
object | Nested deeper than this page draws. | |
(shape 2).credentials.keyPairs[].keys[].chain[].notAfter |
object | Nested deeper than this page draws. | |
(shape 2).credentials.keyPairs[].keys[].chain[].notBefore |
object | Nested deeper than this page draws. | |
(shape 2).credentials.keyPairs[].keys[].chain[].selfSigned |
object | Nested deeper than this page draws. | |
(shape 2).credentials.keyPairs[].keys[].chain[].serialHex |
object | Nested deeper than this page draws. | |
(shape 2).credentials.keyPairs[].keys[].chain[].subject |
object | Nested deeper than this page draws. | |
(shape 2).credentials.keyPairs[].keys[].chain[].thumbprint |
object | Nested deeper than this page draws. | |
(shape 2).credentials.keyPairs[].keys[].chain[].unreadable |
object | Nested deeper than this page draws. | |
(shape 2).credentials.keyPairs[].keys[].expiresAt |
string | ||
(shape 2).credentials.keyPairs[].keys[].handle |
string | ||
(shape 2).credentials.keyPairs[].keys[].label |
string | ||
(shape 2).credentials.keyPairs[].keys[].notAfter |
string | ||
(shape 2).credentials.keyPairs[].keys[].privateKeyHeld |
boolean | ||
(shape 2).credentials.keyPairs[].keys[].reason |
string | ||
(shape 2).credentials.keyPairs[].keys[].revokedAt |
string | ||
(shape 2).credentials.keyPairs[].keys[].serialHex |
string | ||
(shape 2).credentials.keyPairs[].keys[].source |
string | ||
(shape 2).credentials.keyPairs[].keys[].state |
string | ||
(shape 2).credentials.keyPairs[].label |
string | ||
(shape 2).credentials.keyPairs[].purpose |
string | ||
(shape 2).credentials.keyPairs[].valid |
number | ||
(shape 2).credentials.maxPerPerson |
number | ||
(shape 2).credentials.revocationReasons |
list | ||
(shape 2).credentials.revocationReasons[] |
string | ||
(shape 2).credentials.sealsAtRest |
boolean | ||
(shape 2).credentials.selfService |
boolean | ||
(shape 2).credentials.sources |
list | ||
(shape 2).credentials.sources[] |
string | ||
(shape 2).credentials.storable |
boolean | ||
(shape 2).factors |
object | ||
(shape 2).factors.activated |
boolean | ||
(shape 2).factors.appPasswords |
list | ||
(shape 2).factors.appPasswords[].createdAt |
number | ||
(shape 2).factors.appPasswords[].createdBy |
string | ||
(shape 2).factors.appPasswords[].doorLabels |
list | ||
(shape 2).factors.appPasswords[].doorLabels[] |
string | ||
(shape 2).factors.appPasswords[].doors |
list | ||
(shape 2).factors.appPasswords[].doors[] |
string | ||
(shape 2).factors.appPasswords[].id |
string | ||
(shape 2).factors.appPasswords[].lastUsedAt |
number | ||
(shape 2).factors.appPasswords[].lastUsedDoor |
string | ||
(shape 2).factors.appPasswords[].name |
string | ||
(shape 2).factors.backupCodes |
object | ||
(shape 2).factors.backupCodes.generatedAt |
number | ||
(shape 2).factors.backupCodes.hashed |
boolean | ||
(shape 2).factors.backupCodes.lastUsedAt |
number | ||
(shape 2).factors.backupCodes.legacy |
boolean | ||
(shape 2).factors.backupCodes.present |
boolean | ||
(shape 2).factors.backupCodes.remaining |
number | ||
(shape 2).factors.backupCodes.sealed |
boolean | ||
(shape 2).factors.backupCodes.total |
number | ||
(shape 2).factors.backupCodes.usable |
boolean | ||
(shape 2).factors.backupCodes.used |
number | ||
(shape 2).factors.backupCodes.why |
string | ||
(shape 2).factors.disabled |
boolean | ||
(shape 2).factors.keys |
list | ||
(shape 2).factors.keys[].aaguid |
string, or null | ||
(shape 2).factors.keys[].algorithm |
object | ||
(shape 2).factors.keys[].algorithm.coseAlg |
number, or null | ||
(shape 2).factors.keys[].algorithm.insecure |
boolean | ||
(shape 2).factors.keys[].algorithm.lane |
string | ||
(shape 2).factors.keys[].algorithm.name |
string | ||
(shape 2).factors.keys[].algorithm.postQuantum |
boolean | ||
(shape 2).factors.keys[].algorithm.text |
string | ||
(shape 2).factors.keys[].attestation |
object | ||
(shape 2).factors.keys[].attestation.aaguid |
string, or null | ||
(shape 2).factors.keys[].attestation.algorithms |
object | ||
(shape 2).factors.keys[].attestation.algorithms.anchor |
object | ||
(shape 2).factors.keys[].attestation.algorithms.anchor.algorithm |
string | ||
(shape 2).factors.keys[].attestation.algorithms.anchor.composite |
boolean | ||
(shape 2).factors.keys[].attestation.algorithms.anchor.family |
string | ||
(shape 2).factors.keys[].attestation.algorithms.anchor.oid |
string | ||
(shape 2).factors.keys[].attestation.algorithms.anchor.postQuantum |
boolean | ||
(shape 2).factors.keys[].attestation.algorithms.certificates |
list | ||
(shape 2).factors.keys[].attestation.algorithms.certificates[].algorithm |
object | Nested deeper than this page draws. | |
(shape 2).factors.keys[].attestation.algorithms.certificates[].composite |
object | Nested deeper than this page draws. | |
(shape 2).factors.keys[].attestation.algorithms.certificates[].family |
object | Nested deeper than this page draws. | |
(shape 2).factors.keys[].attestation.algorithms.certificates[].oid |
object | Nested deeper than this page draws. | |
(shape 2).factors.keys[].attestation.algorithms.certificates[].postQuantum |
object | Nested deeper than this page draws. | |
(shape 2).factors.keys[].attestation.algorithms.members |
list | ||
(shape 2).factors.keys[].attestation.algorithms.members[].anchor |
object | Nested deeper than this page draws. | |
(shape 2).factors.keys[].attestation.algorithms.members[].certificates |
object | Nested deeper than this page draws. | |
(shape 2).factors.keys[].attestation.algorithms.members[].format |
object | Nested deeper than this page draws. | |
(shape 2).factors.keys[].attestation.algorithms.members[].statement |
object | Nested deeper than this page draws. | |
(shape 2).factors.keys[].attestation.algorithms.members[].statementCoseAlg |
object | Nested deeper than this page draws. | |
(shape 2).factors.keys[].attestation.algorithms.postQuantum |
boolean | ||
(shape 2).factors.keys[].attestation.algorithms.statement |
string | ||
(shape 2).factors.keys[].attestation.algorithms.statementCoseAlg |
integer, or null | ||
(shape 2).factors.keys[].attestation.anchor |
string | ||
(shape 2).factors.keys[].attestation.androidRevocation |
object | ||
(shape 2).factors.keys[].attestation.androidRevocation.chainSerials |
list | ||
(shape 2).factors.keys[].attestation.androidRevocation.chainSerials[] |
string | ||
(shape 2).factors.keys[].attestation.androidRevocation.checkedAt |
string, or number, or null | ||
(shape 2).factors.keys[].attestation.androidRevocation.listVersion |
string | ||
(shape 2).factors.keys[].attestation.androidRevocation.reason |
string | ||
(shape 2).factors.keys[].attestation.androidRevocation.serial |
string | ||
(shape 2).factors.keys[].attestation.androidRevocation.status |
string | ||
(shape 2).factors.keys[].attestation.androidRevocation.why |
string | ||
(shape 2).factors.keys[].attestation.attestationKeyId |
string | ||
(shape 2).factors.keys[].attestation.certificationLevel |
string | ||
(shape 2).factors.keys[].attestation.checkedAt |
number | ||
(shape 2).factors.keys[].attestation.conveyance |
string | ||
(shape 2).factors.keys[].attestation.deviceSerial |
string | ||
(shape 2).factors.keys[].attestation.deviceSerialSource |
string | ||
(shape 2).factors.keys[].attestation.enterpriseDowngraded |
boolean | ||
(shape 2).factors.keys[].attestation.evidence |
object | ||
(shape 2).factors.keys[].attestation.evidence.createdAt |
string, or number, or null | ||
(shape 2).factors.keys[].attestation.evidence.evidenceRecord |
string | ||
(shape 2).factors.keys[].attestation.evidence.hashAlgorithm |
string | ||
(shape 2).factors.keys[].attestation.evidence.object |
string | ||
(shape 2).factors.keys[].attestation.evidence.objectDigest |
string | ||
(shape 2).factors.keys[].attestation.evidence.renewAfter |
string, or number, or null | ||
(shape 2).factors.keys[].attestation.evidence.renewedAt |
string, or number, or null | ||
(shape 2).factors.keys[].attestation.evidence.syntax |
string | ||
(shape 2).factors.keys[].attestation.evidence.timestamps |
list | ||
(shape 2).factors.keys[].attestation.evidence.timestamps[] |
string | ||
(shape 2).factors.keys[].attestation.evidence.tsa |
string, or null | ||
(shape 2).factors.keys[].attestation.evidence.version |
number | ||
(shape 2).factors.keys[].attestation.format |
string | ||
(shape 2).factors.keys[].attestation.mdsStatus |
string | ||
(shape 2).factors.keys[].attestation.mdsVersion |
string, or number, or null | ||
(shape 2).factors.keys[].attestation.model |
string | ||
(shape 2).factors.keys[].attestation.policy |
string | ||
(shape 2).factors.keys[].attestation.trusted |
boolean | ||
(shape 2).factors.keys[].attestation.type |
string | ||
(shape 2).factors.keys[].attestation.verified |
boolean | ||
(shape 2).factors.keys[].attestationAlgorithms |
object | ||
(shape 2).factors.keys[].attestationAlgorithms.certificates |
list | ||
(shape 2).factors.keys[].attestationAlgorithms.certificates[].algorithm |
string | ||
(shape 2).factors.keys[].attestationAlgorithms.certificates[].family |
string | ||
(shape 2).factors.keys[].attestationAlgorithms.certificates[].postQuantum |
boolean | ||
(shape 2).factors.keys[].attestationAlgorithms.postQuantum |
boolean | ||
(shape 2).factors.keys[].attestationAlgorithms.recorded |
boolean | ||
(shape 2).factors.keys[].attestationAlgorithms.statement |
string | ||
(shape 2).factors.keys[].attestationAlgorithms.statements |
list | ||
(shape 2).factors.keys[].attestationAlgorithms.statements[] |
string | ||
(shape 2).factors.keys[].attestationAlgorithms.trusted |
boolean | ||
(shape 2).factors.keys[].attestationAlgorithms.verified |
boolean | ||
(shape 2).factors.keys[].backupEligible |
boolean, or null | ||
(shape 2).factors.keys[].backupState |
boolean, or null | ||
(shape 2).factors.keys[].credentialId |
string | ||
(shape 2).factors.keys[].deviceSerial |
string, or null | ||
(shape 2).factors.keys[].discoverable |
boolean, or null | ||
(shape 2).factors.keys[].enrolledAt |
number | ||
(shape 2).factors.keys[].group |
string | ||
(shape 2).factors.keys[].label |
string, or null | ||
(shape 2).factors.keys[].lane |
string | ||
(shape 2).factors.keys[].lastUsedAt |
number | ||
(shape 2).factors.keys[].name |
string | ||
(shape 2).factors.keys[].possiblyReplaced |
object | ||
(shape 2).factors.keys[].possiblyReplaced.at |
number | ||
(shape 2).factors.keys[].possiblyReplaced.by |
string | ||
(shape 2).factors.keys[].postQuantumRefused |
string | ||
(shape 2).factors.keys[].provider |
string, or null | ||
(shape 2).factors.keys[].signCount |
number | ||
(shape 2).factors.keys[].transports |
list | ||
(shape 2).factors.keys[].transports[] |
string | ||
(shape 2).factors.keys[].withoutUsername |
object | ||
(shape 2).factors.keys[].withoutUsername.ready |
boolean | ||
(shape 2).factors.keys[].withoutUsername.text |
string | ||
(shape 2).factors.mfaKeys |
number | ||
(shape 2).factors.mfaRequired |
boolean | ||
(shape 2).factors.mfaRequirement |
object | ||
(shape 2).factors.mfaRequirement.byAdministrator |
boolean | ||
(shape 2).factors.mfaRequirement.byRealm |
boolean | ||
(shape 2).factors.mfaRequirement.byUser |
boolean | ||
(shape 2).factors.mfaRequirement.exemptServiceAccount |
boolean | ||
(shape 2).factors.mfaRequirement.offered |
boolean | ||
(shape 2).factors.mfaRequirement.required |
boolean | ||
(shape 2).factors.password |
boolean | ||
(shape 2).factors.passwordChangeRequired |
boolean | ||
(shape 2).factors.passwordOnlyDoors |
object | ||
(shape 2).factors.passwordOnlyDoors.accepted |
list | ||
(shape 2).factors.passwordOnlyDoors.accepted[] |
string | ||
(shape 2).factors.passwordOnlyDoors.passwordAloneDoors |
list | ||
(shape 2).factors.passwordOnlyDoors.passwordAloneDoors[] |
string | ||
(shape 2).factors.passwordOnlyDoors.refused |
list | ||
(shape 2).factors.passwordOnlyDoors.refused[] |
string | ||
(shape 2).factors.passwordOnlyDoors.secondFactor |
boolean | ||
(shape 2).factors.passwordOnlyDoors.sentence |
string | ||
(shape 2).factors.passwordResetLink |
object | ||
(shape 2).factors.passwordResetLink.expired |
boolean | ||
(shape 2).factors.passwordResetLink.expires |
number | ||
(shape 2).factors.policy |
object | ||
(shape 2).factors.policy.backupCodesCount |
number | ||
(shape 2).factors.policy.backupCodesEnabled |
boolean | ||
(shape 2).factors.policy.maxKeysPerPerson |
number | ||
(shape 2).factors.policy.mfaAllowed |
boolean | ||
(shape 2).factors.policy.primaryAllowed |
boolean | ||
(shape 2).factors.policy.totpEnabled |
boolean | ||
(shape 2).factors.policy.webauthnEnabled |
boolean | ||
(shape 2).factors.primaryKeys |
number | ||
(shape 2).factors.secondFactor |
string, or null | ||
(shape 2).factors.totp |
boolean | ||
(shape 2).factors.totpDetail |
object | ||
(shape 2).factors.totpDetail.algorithm |
string | ||
(shape 2).factors.totpDetail.digits |
number | ||
(shape 2).factors.totpDetail.enrolledAt |
number | ||
(shape 2).factors.totpDetail.lastUsedAt |
number | ||
(shape 2).factors.totpDetail.period |
number | ||
(shape 2).factors.totpDetail.sealed |
boolean | ||
(shape 2).factors.totpDetail.unusable |
boolean | ||
(shape 2).factors.totpDetail.why |
string | ||
(shape 2).factors.totpUsable |
boolean | ||
(shape 2).factors.usable |
boolean | ||
(shape 2).federationLinks |
list | ||
(shape 2).federationLinks[].issuer |
string | ||
(shape 2).federationLinks[].link |
string | ||
(shape 2).federationLinks[].relationship |
string | ||
(shape 2).federationLinks[].relationshipExists |
boolean | ||
(shape 2).federationLinks[].subject |
string | ||
(shape 2).federationLinksPaging |
object | ||
(shape 2).federationLinksPaging.firstRow |
integer | ||
(shape 2).federationLinksPaging.lastRow |
integer | ||
(shape 2).federationLinksPaging.noun |
string | ||
(shape 2).federationLinksPaging.page |
integer | ||
(shape 2).federationLinksPaging.pages |
integer | ||
(shape 2).federationLinksPaging.param |
string | ||
(shape 2).federationLinksPaging.perPage |
integer | ||
(shape 2).federationLinksPaging.total |
integer | ||
(shape 2).gnapGrants |
list | ||
(shape 2).gnapGrants[].approvedBy |
string | ||
(shape 2).gnapGrants[].authorizationServer |
string, or null | ||
(shape 2).gnapGrants[].client |
string, or null | ||
(shape 2).gnapGrants[].clientName |
string, or null | ||
(shape 2).gnapGrants[].createdAt |
number, or null | ||
(shape 2).gnapGrants[].derivedFrom |
string, or null | ||
(shape 2).gnapGrants[].finalization |
object | ||
(shape 2).gnapGrants[].finalization.at |
number | ||
(shape 2).gnapGrants[].finalization.note |
string | ||
(shape 2).gnapGrants[].finalization.reason |
string | ||
(shape 2).gnapGrants[].grantExpiresAt |
number, or null | ||
(shape 2).gnapGrants[].id |
string | ||
(shape 2).gnapGrants[].revocable |
boolean | ||
(shape 2).gnapGrants[].rights |
any JSON | An RFC 9635 access right as the client asked for it: a reference string or an object in the access type the resource server defines. An RFC 9635 access right as the client asked for it: a reference string or an object in the access type the resource server defines. | |
(shape 2).gnapGrants[].rightsAre |
string | ||
(shape 2).gnapGrants[].state |
string | ||
(shape 2).gnapGrants[].subjectReleasedAt |
number, or null | ||
(shape 2).gnapGrants[].tokens |
list | ||
(shape 2).gnapGrants[].tokens[].access |
any JSON | An RFC 9635 access right as the client asked for it: a reference string or an object in the access type the resource server defines. An RFC 9635 access right as the client asked for it: a reference string or an object in the access type the resource server defines. | |
(shape 2).gnapGrants[].tokens[].bearer |
boolean | ||
(shape 2).gnapGrants[].tokens[].expiresAt |
number, or null | ||
(shape 2).gnapGrants[].tokens[].format |
string | ||
(shape 2).gnapGrants[].tokens[].issuedAt |
number, or null | ||
(shape 2).gnapGrants[].tokens[].jti |
string | ||
(shape 2).gnapGrants[].tokens[].label |
string, or null | ||
(shape 2).gnapGrants[].tokens[].revokedWhy |
string, or null | ||
(shape 2).gnapGrants[].tokens[].state |
string | ||
(shape 2).gnapGrants[].updatedAt |
number, or null | ||
(shape 2).gnapGrantsCells |
object | ||
(shape 2).gnapGrantsCells.cell |
string | ||
(shape 2).gnapGrantsCells.complete |
boolean | ||
(shape 2).gnapGrantsCells.multiCell |
boolean | ||
(shape 2).gnapGrantsCells.note |
string | ||
(shape 2).gnapGrantsPaging |
object | ||
(shape 2).gnapGrantsPaging.firstRow |
integer | ||
(shape 2).gnapGrantsPaging.lastRow |
integer | ||
(shape 2).gnapGrantsPaging.noun |
string | ||
(shape 2).gnapGrantsPaging.page |
integer | ||
(shape 2).gnapGrantsPaging.pages |
integer | ||
(shape 2).gnapGrantsPaging.param |
string | ||
(shape 2).gnapGrantsPaging.perPage |
integer | ||
(shape 2).gnapGrantsPaging.total |
integer | ||
(shape 2).kerberos |
object | ||
(shape 2).kerberos.disabled |
boolean | ||
(shape 2).kerberos.kdc |
boolean | ||
(shape 2).kerberos.keys |
object | ||
(shape 2).kerberos.keys.current |
boolean | ||
(shape 2).kerberos.keys.derivedAt |
string | ||
(shape 2).kerberos.keys.derivedOn |
string | ||
(shape 2).kerberos.keys.etypes |
list | ||
(shape 2).kerberos.keys.etypes[].etype |
number | ||
(shape 2).kerberos.keys.etypes[].name |
string | ||
(shape 2).kerberos.keys.kvno |
number, or null | ||
(shape 2).kerberos.keys.retained |
list | ||
(shape 2).kerberos.keys.retained[].etypes |
list | ||
(shape 2).kerberos.keys.retained[].etypes[].etype |
number | ||
(shape 2).kerberos.keys.retained[].etypes[].name |
string | ||
(shape 2).kerberos.keys.retained[].expiresAt |
string | ||
(shape 2).kerberos.keys.retained[].kvno |
number, or null | ||
(shape 2).kerberos.keys.retained[].retiredAt |
string | ||
(shape 2).kerberos.keys.sealed |
boolean | ||
(shape 2).kerberos.nameUsable |
boolean | ||
(shape 2).kerberos.person |
boolean | ||
(shape 2).kerberos.personKeys |
boolean | ||
(shape 2).kerberos.principal |
string | ||
(shape 2).kerberos.productKdc |
boolean, or null | ||
(shape 2).kerberos.realm |
string | ||
(shape 2).kerberos.reason |
string | ||
(shape 2).kerberos.trustRealm |
string | ||
(shape 2).known |
boolean | ||
(shape 2).ldap |
object | ||
(shape 2).ldap.alsoNamed |
list | ||
(shape 2).ldap.alsoNamed[] |
string | ||
(shape 2).ldap.autoCreateUsers |
boolean | ||
(shape 2).ldap.baseDn |
string | ||
(shape 2).ldap.dn |
string | ||
(shape 2).ldap.entry |
object | ||
(shape 2).ldap.entry.attributes |
map | ||
(shape 2).ldap.entry.attributes.{key} |
list, or string | ||
(shape 2).ldap.entry.attributes.{key}[] |
string | ||
(shape 2).ldap.entry.createdAt |
string, or number, or null | ||
(shape 2).ldap.entry.dn |
string | ||
(shape 2).ldap.entry.members |
list | ||
(shape 2).ldap.entry.members[].attribute |
string | ||
(shape 2).ldap.entry.members[].cn |
string | ||
(shape 2).ldap.entry.members[].displayName |
string | ||
(shape 2).ldap.entry.members[].dn |
string | ||
(shape 2).ldap.entry.members[].holds |
string | ||
(shape 2).ldap.entry.members[].kind |
string | ||
(shape 2).ldap.entry.members[].mail |
string | ||
(shape 2).ldap.entry.members[].present |
boolean | ||
(shape 2).ldap.entry.members[].userKey |
string | ||
(shape 2).ldap.entry.members[].value |
string | ||
(shape 2).ldap.entry.modifiedAt |
string, or number, or null | ||
(shape 2).ldap.entry.operational |
list | ||
(shape 2).ldap.entry.operational[] |
string | ||
(shape 2).ldap.entry.origin |
string | ||
(shape 2).ldap.entry.rule |
string | ||
(shape 2).ldap.entryCount |
number | ||
(shape 2).ldap.found |
boolean | ||
(shape 2).ldap.full |
boolean | ||
(shape 2).ldap.ldapsListening |
boolean | ||
(shape 2).ldap.ldapsPort |
number, or null | ||
(shape 2).ldap.listenError |
string, or null | ||
(shape 2).ldap.listening |
boolean | ||
(shape 2).ldap.maxEntries |
number | ||
(shape 2).ldap.port |
number, or null | ||
(shape 2).ldap.usersDn |
string | ||
(shape 2).page |
object | ||
(shape 2).page.back |
string | ||
(shape 2).page.blocksPerPage |
number | ||
(shape 2).page.counts |
object | ||
(shape 2).page.counts.artifacts |
number | ||
(shape 2).page.counts.ended |
number | ||
(shape 2).page.counts.expired |
number | ||
(shape 2).page.counts.live |
number | ||
(shape 2).page.counts.sessionless |
number | ||
(shape 2).page.counts.tokens |
number | ||
(shape 2).page.counts.valid |
number | ||
(shape 2).page.delegation |
object | ||
(shape 2).page.delegation.defaultSemantics |
string | ||
(shape 2).page.delegation.delegate |
object, or string, or null | ||
(shape 2).page.delegation.delegate.dn |
string | ||
(shape 2).page.delegation.delegate.kind |
string | ||
(shape 2).page.delegation.delegate.name |
string | ||
(shape 2).page.delegation.delegate.present |
boolean | ||
(shape 2).page.delegation.delegate.sub |
string | ||
(shape 2).page.delegation.dn |
string | ||
(shape 2).page.delegation.found |
boolean | ||
(shape 2).page.delegation.groups |
list | ||
(shape 2).page.delegation.groups[].cn |
string | ||
(shape 2).page.delegation.groups[].dn |
string | ||
(shape 2).page.delegation.mayAct |
string | ||
(shape 2).page.delegation.notDelegated |
boolean | ||
(shape 2).page.delegation.person |
boolean | ||
(shape 2).page.delegation.semantics |
list | ||
(shape 2).page.delegation.semantics[] |
string | ||
(shape 2).page.delegation.sub |
string | ||
(shape 2).page.delegation.username |
string | ||
(shape 2).page.directoryLoaded |
boolean | ||
(shape 2).page.fieldGroups |
list | ||
(shape 2).page.fieldGroups[].attributes |
list | ||
(shape 2).page.fieldGroups[].attributes[] |
string | ||
(shape 2).page.fieldGroups[].id |
string | ||
(shape 2).page.fieldGroups[].label |
string | ||
(shape 2).page.fieldGroups[].what |
string | ||
(shape 2).page.key |
string | ||
(shape 2).page.keyPairs |
object | ||
(shape 2).page.keyPairs.ca |
object | ||
(shape 2).page.keyPairs.ca.available |
boolean | ||
(shape 2).page.keyPairs.ca.keyAlg |
string | ||
(shape 2).page.keyPairs.ca.keyAlgorithms |
list | ||
(shape 2).page.keyPairs.ca.keyAlgorithms[].id |
string | ||
(shape 2).page.keyPairs.ca.keyAlgorithms[].kind |
string | ||
(shape 2).page.keyPairs.ca.keyAlgorithms[].label |
string | ||
(shape 2).page.keyPairs.ca.keyAlgorithms[].tlsUsable |
boolean | ||
(shape 2).page.keyPairs.ca.leafLifetimeDays |
number | ||
(shape 2).page.keyPairs.found |
boolean | ||
(shape 2).page.keyPairs.maxPerPerson |
number | ||
(shape 2).page.keyPairs.purposes |
list | ||
(shape 2).page.keyPairs.purposes[].atCap |
boolean | ||
(shape 2).page.keyPairs.purposes[].attributes |
object | ||
(shape 2).page.keyPairs.purposes[].attributes.issuer |
string | ||
(shape 2).page.keyPairs.purposes[].attributes.keys |
string | ||
(shape 2).page.keyPairs.purposes[].attributes.privateKey |
string | ||
(shape 2).page.keyPairs.purposes[].effectiveIssuers |
list | ||
(shape 2).page.keyPairs.purposes[].effectiveIssuers[] |
string | ||
(shape 2).page.keyPairs.purposes[].handleLabel |
string | ||
(shape 2).page.keyPairs.purposes[].held |
boolean | ||
(shape 2).page.keyPairs.purposes[].id |
string | ||
(shape 2).page.keyPairs.purposes[].issuers |
list | ||
(shape 2).page.keyPairs.purposes[].issuers[] |
string | ||
(shape 2).page.keyPairs.purposes[].keys |
list | ||
(shape 2).page.keyPairs.purposes[].keys[].certificate |
object | ||
(shape 2).page.keyPairs.purposes[].keys[].certificate.expired |
object | Nested deeper than this page draws. | |
(shape 2).page.keyPairs.purposes[].keys[].certificate.issuer |
object | Nested deeper than this page draws. | |
(shape 2).page.keyPairs.purposes[].keys[].certificate.keyType |
object | Nested deeper than this page draws. | |
(shape 2).page.keyPairs.purposes[].keys[].certificate.notAfter |
object | Nested deeper than this page draws. | |
(shape 2).page.keyPairs.purposes[].keys[].certificate.notBefore |
object | Nested deeper than this page draws. | |
(shape 2).page.keyPairs.purposes[].keys[].certificate.selfSigned |
object | Nested deeper than this page draws. | |
(shape 2).page.keyPairs.purposes[].keys[].certificate.serialHex |
object | Nested deeper than this page draws. | |
(shape 2).page.keyPairs.purposes[].keys[].certificate.subject |
object | Nested deeper than this page draws. | |
(shape 2).page.keyPairs.purposes[].keys[].certificate.thumbprint |
object | Nested deeper than this page draws. | |
(shape 2).page.keyPairs.purposes[].keys[].certificate.unreadable |
object | Nested deeper than this page draws. | |
(shape 2).page.keyPairs.purposes[].keys[].chain |
list | ||
(shape 2).page.keyPairs.purposes[].keys[].chain[] |
object | Nested deeper than this page draws. | |
(shape 2).page.keyPairs.purposes[].keys[].expiresAt |
string | ||
(shape 2).page.keyPairs.purposes[].keys[].handle |
string | ||
(shape 2).page.keyPairs.purposes[].keys[].label |
string | ||
(shape 2).page.keyPairs.purposes[].keys[].notAfter |
string | ||
(shape 2).page.keyPairs.purposes[].keys[].privateKeyHeld |
boolean | ||
(shape 2).page.keyPairs.purposes[].keys[].reason |
string | ||
(shape 2).page.keyPairs.purposes[].keys[].revokedAt |
string | ||
(shape 2).page.keyPairs.purposes[].keys[].serialHex |
string | ||
(shape 2).page.keyPairs.purposes[].keys[].source |
string | ||
(shape 2).page.keyPairs.purposes[].keys[].state |
string | ||
(shape 2).page.keyPairs.purposes[].label |
string | ||
(shape 2).page.keyPairs.purposes[].valid |
number | ||
(shape 2).page.keyPairs.revocationReasons |
list | ||
(shape 2).page.keyPairs.revocationReasons[] |
string | ||
(shape 2).page.keyPairs.sealsAtRest |
boolean | ||
(shape 2).page.keyPairs.selfService |
boolean | ||
(shape 2).page.keyPairs.sources |
list | ||
(shape 2).page.keyPairs.sources[] |
string | ||
(shape 2).page.keyPairs.storable |
boolean | ||
(shape 2).page.keyPairs.username |
string | ||
(shape 2).page.maxEventsPerUser |
number | ||
(shape 2).page.mfa |
object | ||
(shape 2).page.mfa.appPasswords |
object | ||
(shape 2).page.mfa.appPasswords.errors |
list | ||
(shape 2).page.mfa.appPasswords.errors[] |
string | ||
(shape 2).page.mfa.appPasswords.ok |
boolean | ||
(shape 2).page.mfa.appPasswords.passwords |
list | ||
(shape 2).page.mfa.appPasswords.passwords[].createdAt |
number | ||
(shape 2).page.mfa.appPasswords.passwords[].createdBy |
string | ||
(shape 2).page.mfa.appPasswords.passwords[].doorLabels |
list | ||
(shape 2).page.mfa.appPasswords.passwords[].doorLabels[] |
string | ||
(shape 2).page.mfa.appPasswords.passwords[].doors |
list | ||
(shape 2).page.mfa.appPasswords.passwords[].doors[] |
string | ||
(shape 2).page.mfa.appPasswords.passwords[].id |
string | ||
(shape 2).page.mfa.appPasswords.passwords[].lastUsedAt |
number | ||
(shape 2).page.mfa.appPasswords.passwords[].lastUsedDoor |
string | ||
(shape 2).page.mfa.appPasswords.passwords[].name |
string | ||
(shape 2).page.mfa.appPasswords.unreadable |
boolean | ||
(shape 2).page.mfa.certificates |
object | ||
(shape 2).page.mfa.certificates.certificates |
list | ||
(shape 2).page.mfa.certificates.certificates[].expired |
boolean | ||
(shape 2).page.mfa.certificates.certificates[].issuer |
string | ||
(shape 2).page.mfa.certificates.certificates[].notAfter |
string | ||
(shape 2).page.mfa.certificates.certificates[].notBefore |
string | ||
(shape 2).page.mfa.certificates.certificates[].readable |
boolean | ||
(shape 2).page.mfa.certificates.certificates[].serialNumber |
string | ||
(shape 2).page.mfa.certificates.certificates[].sha256 |
string | ||
(shape 2).page.mfa.certificates.certificates[].subject |
string | ||
(shape 2).page.mfa.certificates.dn |
string | ||
(shape 2).page.mfa.certificates.errors |
list | ||
(shape 2).page.mfa.certificates.errors[] |
string | ||
(shape 2).page.mfa.certificates.ok |
boolean | ||
(shape 2).page.mfa.certificates.rule |
string | ||
(shape 2).page.mfa.certificates.user |
string | ||
(shape 2).page.mfa.devices |
object | ||
(shape 2).page.mfa.devices.devices |
list | ||
(shape 2).page.mfa.devices.devices[].applications |
list | ||
(shape 2).page.mfa.devices.devices[].applications[] |
string | ||
(shape 2).page.mfa.devices.devices[].attestation |
object | ||
(shape 2).page.mfa.devices.devices[].attestation.format |
string | ||
(shape 2).page.mfa.devices.devices[].attestation.keyId |
string | ||
(shape 2).page.mfa.devices.devices[].attestation.level |
string | ||
(shape 2).page.mfa.devices.devices[].attestation.summary |
string | ||
(shape 2).page.mfa.devices.devices[].compliance |
string | ||
(shape 2).page.mfa.devices.devices[].complianceChange |
object | ||
(shape 2).page.mfa.devices.devices[].complianceChange.actor |
string | ||
(shape 2).page.mfa.devices.devices[].complianceChange.at |
string, or number, or null | ||
(shape 2).page.mfa.devices.devices[].complianceChange.compliance |
string | ||
(shape 2).page.mfa.devices.devices[].complianceChange.level |
string | ||
(shape 2).page.mfa.devices.devices[].complianceChange.previous |
string, or null | ||
(shape 2).page.mfa.devices.devices[].complianceChange.reason |
string | ||
(shape 2).page.mfa.devices.devices[].complianceChange.source |
string | ||
(shape 2).page.mfa.devices.devices[].complianceChange.status |
string | ||
(shape 2).page.mfa.devices.devices[].created |
string, or number, or null | ||
(shape 2).page.mfa.devices.devices[].dn |
string | ||
(shape 2).page.mfa.devices.devices[].enrolment |
object | ||
(shape 2).page.mfa.devices.devices[].enrolment.actor |
string | ||
(shape 2).page.mfa.devices.devices[].enrolment.at |
string, or number, or null | ||
(shape 2).page.mfa.devices.devices[].enrolment.method |
string | ||
(shape 2).page.mfa.devices.devices[].id |
string | ||
(shape 2).page.mfa.devices.devices[].keyKinds |
list | ||
(shape 2).page.mfa.devices.devices[].keyKinds[] |
string | ||
(shape 2).page.mfa.devices.devices[].keys |
list | ||
(shape 2).page.mfa.devices.devices[].keys[].added |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.devices.devices[].keys[].addedBy |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.devices.devices[].keys[].attestation |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.devices.devices[].keys[].id |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.devices.devices[].keys[].kind |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.devices.devices[].keys[].label |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.devices.devices[].keys[].material |
object | A device key’s public material as its kind carries it: a client’s JWK, a certificate, or a WebAuthn credential. Nested deeper than this page draws. | |
(shape 2).page.mfa.devices.devices[].keys[].proof |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.devices.devices[].keys[].thumbprint |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.devices.devices[].label |
string | ||
(shape 2).page.mfa.devices.devices[].lastUsed |
string, or number, or null | ||
(shape 2).page.mfa.devices.devices[].model |
string | ||
(shape 2).page.mfa.devices.devices[].nativeSso |
boolean | ||
(shape 2).page.mfa.devices.devices[].os |
string | ||
(shape 2).page.mfa.devices.devices[].owner |
string | ||
(shape 2).page.mfa.devices.devices[].ownerKind |
string | ||
(shape 2).page.mfa.devices.devices[].platform |
string | ||
(shape 2).page.mfa.devices.devices[].rememberedBrowser |
object | ||
(shape 2).page.mfa.devices.devices[].rememberedBrowser.browser |
string | ||
(shape 2).page.mfa.devices.devices[].rememberedBrowser.generation |
number | ||
(shape 2).page.mfa.devices.devices[].rememberedBrowser.issuedAt |
string | ||
(shape 2).page.mfa.devices.devices[].rememberedBrowser.secondFactorAt |
string | ||
(shape 2).page.mfa.devices.devices[].riskChange |
object | ||
(shape 2).page.mfa.devices.devices[].riskChange.actor |
string | ||
(shape 2).page.mfa.devices.devices[].riskChange.at |
string, or number, or null | ||
(shape 2).page.mfa.devices.devices[].riskChange.compliance |
string | ||
(shape 2).page.mfa.devices.devices[].riskChange.level |
string | ||
(shape 2).page.mfa.devices.devices[].riskChange.previous |
string, or null | ||
(shape 2).page.mfa.devices.devices[].riskChange.reason |
string | ||
(shape 2).page.mfa.devices.devices[].riskChange.source |
string | ||
(shape 2).page.mfa.devices.devices[].riskChange.status |
string | ||
(shape 2).page.mfa.devices.devices[].riskLevel |
string | ||
(shape 2).page.mfa.devices.devices[].sessionLive |
boolean | ||
(shape 2).page.mfa.devices.devices[].status |
string | ||
(shape 2).page.mfa.devices.devices[].statusChange |
object | ||
(shape 2).page.mfa.devices.devices[].statusChange.actor |
string | ||
(shape 2).page.mfa.devices.devices[].statusChange.at |
string, or number, or null | ||
(shape 2).page.mfa.devices.devices[].statusChange.compliance |
string | ||
(shape 2).page.mfa.devices.devices[].statusChange.level |
string | ||
(shape 2).page.mfa.devices.devices[].statusChange.previous |
string, or null | ||
(shape 2).page.mfa.devices.devices[].statusChange.reason |
string | ||
(shape 2).page.mfa.devices.devices[].statusChange.source |
string | ||
(shape 2).page.mfa.devices.devices[].statusChange.status |
string | ||
(shape 2).page.mfa.devices.maxPerPerson |
number | ||
(shape 2).page.mfa.devices.user |
string | ||
(shape 2).page.mfa.doors |
object | ||
(shape 2).page.mfa.doors.accepted |
list | ||
(shape 2).page.mfa.doors.accepted[] |
string | ||
(shape 2).page.mfa.doors.passwordAloneDoors |
list | ||
(shape 2).page.mfa.doors.passwordAloneDoors[] |
string | ||
(shape 2).page.mfa.doors.refused |
list | ||
(shape 2).page.mfa.doors.refused[] |
string | ||
(shape 2).page.mfa.doors.secondFactor |
boolean | ||
(shape 2).page.mfa.doors.sentence |
string | ||
(shape 2).page.mfa.inventsClaimValues |
boolean | ||
(shape 2).page.mfa.mail |
object | ||
(shape 2).page.mfa.mail.audSubs |
list | ||
(shape 2).page.mfa.mail.audSubs[] |
string | ||
(shape 2).page.mfa.mail.status |
object | ||
(shape 2).page.mfa.mail.status.address |
string | ||
(shape 2).page.mfa.mail.status.failures |
number | ||
(shape 2).page.mfa.mail.status.kind |
string | ||
(shape 2).page.mfa.mail.status.offered |
object | ||
(shape 2).page.mfa.mail.status.offered.code |
boolean | ||
(shape 2).page.mfa.mail.status.offered.link |
boolean | ||
(shape 2).page.mfa.mail.status.optedIn |
string | ||
(shape 2).page.mfa.mail.status.usable |
boolean | ||
(shape 2).page.mfa.mail.status.verified |
boolean | ||
(shape 2).page.mfa.mail.status.why |
string | ||
(shape 2).page.mfa.mail.usable |
boolean | ||
(shape 2).page.mfa.mech |
object | ||
(shape 2).page.mfa.mech.activated |
boolean | ||
(shape 2).page.mfa.mech.backupCodes |
object | ||
(shape 2).page.mfa.mech.backupCodes.generatedAt |
number | ||
(shape 2).page.mfa.mech.backupCodes.hashed |
boolean | ||
(shape 2).page.mfa.mech.backupCodes.lastUsedAt |
number | ||
(shape 2).page.mfa.mech.backupCodes.legacy |
boolean | ||
(shape 2).page.mfa.mech.backupCodes.present |
boolean | ||
(shape 2).page.mfa.mech.backupCodes.remaining |
number | ||
(shape 2).page.mfa.mech.backupCodes.sealed |
boolean | ||
(shape 2).page.mfa.mech.backupCodes.total |
number | ||
(shape 2).page.mfa.mech.backupCodes.usable |
boolean | ||
(shape 2).page.mfa.mech.backupCodes.used |
number | ||
(shape 2).page.mfa.mech.backupCodes.why |
string | ||
(shape 2).page.mfa.mech.disabled |
boolean | ||
(shape 2).page.mfa.mech.keys |
list | ||
(shape 2).page.mfa.mech.keys[].aaguid |
string, or null | ||
(shape 2).page.mfa.mech.keys[].algorithm |
object, or string, or null | ||
(shape 2).page.mfa.mech.keys[].algorithm.coseAlg |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].algorithm.insecure |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].algorithm.lane |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].algorithm.name |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].algorithm.postQuantum |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].algorithm.text |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attachment |
string, or null | ||
(shape 2).page.mfa.mech.keys[].attestation |
object | ||
(shape 2).page.mfa.mech.keys[].attestation.aaguid |
string, or null | ||
(shape 2).page.mfa.mech.keys[].attestation.algorithms |
object | ||
(shape 2).page.mfa.mech.keys[].attestation.algorithms.anchor |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.algorithms.certificates |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.algorithms.members |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.algorithms.postQuantum |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.algorithms.statement |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.algorithms.statementCoseAlg |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.anchor |
string | ||
(shape 2).page.mfa.mech.keys[].attestation.androidRevocation |
object | ||
(shape 2).page.mfa.mech.keys[].attestation.androidRevocation.chainSerials |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.androidRevocation.checkedAt |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.androidRevocation.listVersion |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.androidRevocation.reason |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.androidRevocation.serial |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.androidRevocation.status |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.androidRevocation.why |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.attestationKeyId |
string | ||
(shape 2).page.mfa.mech.keys[].attestation.certificationLevel |
string | ||
(shape 2).page.mfa.mech.keys[].attestation.checkedAt |
number | ||
(shape 2).page.mfa.mech.keys[].attestation.conveyance |
string | ||
(shape 2).page.mfa.mech.keys[].attestation.deviceSerial |
string | ||
(shape 2).page.mfa.mech.keys[].attestation.deviceSerialSource |
string | ||
(shape 2).page.mfa.mech.keys[].attestation.enterpriseDowngraded |
boolean | ||
(shape 2).page.mfa.mech.keys[].attestation.evidence |
object | ||
(shape 2).page.mfa.mech.keys[].attestation.evidence.createdAt |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.evidence.evidenceRecord |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.evidence.hashAlgorithm |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.evidence.object |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.evidence.objectDigest |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.evidence.renewAfter |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.evidence.renewedAt |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.evidence.syntax |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.evidence.timestamps |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.evidence.tsa |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.evidence.version |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].attestation.format |
string | ||
(shape 2).page.mfa.mech.keys[].attestation.mdsStatus |
string | ||
(shape 2).page.mfa.mech.keys[].attestation.mdsVersion |
string, or number, or null | ||
(shape 2).page.mfa.mech.keys[].attestation.model |
string | ||
(shape 2).page.mfa.mech.keys[].attestation.policy |
string | ||
(shape 2).page.mfa.mech.keys[].attestation.trusted |
boolean | ||
(shape 2).page.mfa.mech.keys[].attestation.type |
string | ||
(shape 2).page.mfa.mech.keys[].attestation.verified |
boolean | ||
(shape 2).page.mfa.mech.keys[].attestationRefused |
object | ||
(shape 2).page.mfa.mech.keys[].attestationRefused.at |
number | ||
(shape 2).page.mfa.mech.keys[].attestationRefused.why |
string | ||
(shape 2).page.mfa.mech.keys[].backupEligible |
boolean, or null | ||
(shape 2).page.mfa.mech.keys[].backupState |
boolean, or null | ||
(shape 2).page.mfa.mech.keys[].coseAlg |
number, or null | ||
(shape 2).page.mfa.mech.keys[].credentialId |
string | ||
(shape 2).page.mfa.mech.keys[].discoverable |
boolean, or null | ||
(shape 2).page.mfa.mech.keys[].enrolledAt |
number | ||
(shape 2).page.mfa.mech.keys[].enrolledBy |
object | ||
(shape 2).page.mfa.mech.keys[].enrolledBy.at |
number | ||
(shape 2).page.mfa.mech.keys[].enrolledBy.sub |
string | ||
(shape 2).page.mfa.mech.keys[].enrolledBy.username |
string | ||
(shape 2).page.mfa.mech.keys[].group |
string | ||
(shape 2).page.mfa.mech.keys[].label |
string | ||
(shape 2).page.mfa.mech.keys[].lane |
string | ||
(shape 2).page.mfa.mech.keys[].lastUsedAt |
number | ||
(shape 2).page.mfa.mech.keys[].minPinLength |
number, or null | ||
(shape 2).page.mfa.mech.keys[].name |
string | ||
(shape 2).page.mfa.mech.keys[].policyRefused |
map | ||
(shape 2).page.mfa.mech.keys[].policyRefused.{key}.at |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].policyRefused.{key}.why |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].possiblyReplacedAt |
number | ||
(shape 2).page.mfa.mech.keys[].possiblyReplacedBy |
string | ||
(shape 2).page.mfa.mech.keys[].previousAlgorithm |
string | ||
(shape 2).page.mfa.mech.keys[].previousCoseAlg |
number, or null | ||
(shape 2).page.mfa.mech.keys[].previousCredentialId |
string | ||
(shape 2).page.mfa.mech.keys[].provider |
string, or null | ||
(shape 2).page.mfa.mech.keys[].providerSource |
string | ||
(shape 2).page.mfa.mech.keys[].publicKeyJwk |
object | ||
(shape 2).page.mfa.mech.keys[].publicKeyJwk.alg |
string | ||
(shape 2).page.mfa.mech.keys[].publicKeyJwk.crv |
string | ||
(shape 2).page.mfa.mech.keys[].publicKeyJwk.e |
string | ||
(shape 2).page.mfa.mech.keys[].publicKeyJwk.ext |
boolean | ||
(shape 2).page.mfa.mech.keys[].publicKeyJwk.key_ops |
list | ||
(shape 2).page.mfa.mech.keys[].publicKeyJwk.key_ops[] |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.mech.keys[].publicKeyJwk.kid |
string | ||
(shape 2).page.mfa.mech.keys[].publicKeyJwk.kty |
string | ||
(shape 2).page.mfa.mech.keys[].publicKeyJwk.n |
string | ||
(shape 2).page.mfa.mech.keys[].publicKeyJwk.pub |
string | ||
(shape 2).page.mfa.mech.keys[].publicKeyJwk.use |
string | ||
(shape 2).page.mfa.mech.keys[].publicKeyJwk.x |
string | ||
(shape 2).page.mfa.mech.keys[].publicKeyJwk.y |
string | ||
(shape 2).page.mfa.mech.keys[].signCount |
number | ||
(shape 2).page.mfa.mech.keys[].transports |
list | ||
(shape 2).page.mfa.mech.keys[].transports[] |
string | ||
(shape 2).page.mfa.mech.keys[].upgradeMode |
string | ||
(shape 2).page.mfa.mech.keys[].upgradedAt |
number | ||
(shape 2).page.mfa.mech.keys[].upgradedTo |
string | ||
(shape 2).page.mfa.mech.keys[].userHandle |
string | ||
(shape 2).page.mfa.mech.keys[].userVerified |
boolean, or null | ||
(shape 2).page.mfa.mech.mailFactor |
object | ||
(shape 2).page.mfa.mech.mailFactor.held |
string | ||
(shape 2).page.mfa.mech.mailFactor.optedIn |
string | ||
(shape 2).page.mfa.mech.mailFactor.verified |
boolean | ||
(shape 2).page.mfa.mech.mailFactor.why |
string | ||
(shape 2).page.mfa.mech.mfaKeys |
number | ||
(shape 2).page.mfa.mech.mfaRequired |
boolean | ||
(shape 2).page.mfa.mech.mfaRequirement |
object | ||
(shape 2).page.mfa.mech.mfaRequirement.byAdministrator |
boolean | ||
(shape 2).page.mfa.mech.mfaRequirement.byRealm |
boolean | ||
(shape 2).page.mfa.mech.mfaRequirement.byUser |
boolean | ||
(shape 2).page.mfa.mech.mfaRequirement.exemptServiceAccount |
boolean | ||
(shape 2).page.mfa.mech.mfaRequirement.offered |
boolean | ||
(shape 2).page.mfa.mech.mfaRequirement.required |
boolean | ||
(shape 2).page.mfa.mech.password |
boolean | ||
(shape 2).page.mfa.mech.passwordResetLink |
object | ||
(shape 2).page.mfa.mech.passwordResetLink.expired |
boolean | ||
(shape 2).page.mfa.mech.passwordResetLink.expires |
number | ||
(shape 2).page.mfa.mech.primaryKeys |
number | ||
(shape 2).page.mfa.mech.recoveryAdvised |
boolean | ||
(shape 2).page.mfa.mech.secondFactor |
string, or null | ||
(shape 2).page.mfa.mech.totp |
boolean | ||
(shape 2).page.mfa.mech.totpDetail |
object | ||
(shape 2).page.mfa.mech.totpDetail.algorithm |
string | ||
(shape 2).page.mfa.mech.totpDetail.digits |
number | ||
(shape 2).page.mfa.mech.totpDetail.enrolledAt |
number | ||
(shape 2).page.mfa.mech.totpDetail.lastUsedAt |
number | ||
(shape 2).page.mfa.mech.totpDetail.period |
number | ||
(shape 2).page.mfa.mech.totpDetail.sealed |
boolean | ||
(shape 2).page.mfa.mech.totpDetail.unusable |
boolean | ||
(shape 2).page.mfa.mech.totpDetail.why |
string | ||
(shape 2).page.mfa.mech.totpUsable |
boolean | ||
(shape 2).page.mfa.mech.usable |
boolean | ||
(shape 2).page.mfa.mech.username |
string | ||
(shape 2).page.mfa.publishedDids |
object | ||
(shape 2).page.mfa.publishedDids.custody |
string | ||
(shape 2).page.mfa.publishedDids.dids |
list | ||
(shape 2).page.mfa.publishedDids.dids[].by |
string | ||
(shape 2).page.mfa.publishedDids.dids[].createdAt |
string, or number, or null | ||
(shape 2).page.mfa.publishedDids.dids[].currentVersion |
string, or number | ||
(shape 2).page.mfa.publishedDids.dids[].custody |
string | ||
(shape 2).page.mfa.publishedDids.dids[].deactivated |
object, or boolean, or string, or null | ||
(shape 2).page.mfa.publishedDids.dids[].deactivated.at |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.publishedDids.dids[].deactivated.by |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.publishedDids.dids[].deactivated.reason |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.publishedDids.dids[].deactivated.via |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.publishedDids.dids[].did |
string | ||
(shape 2).page.mfa.publishedDids.dids[].documentUrl |
string | ||
(shape 2).page.mfa.publishedDids.dids[].pending |
object | ||
(shape 2).page.mfa.publishedDids.dids[].pending.change |
string | ||
(shape 2).page.mfa.publishedDids.dids[].pending.expiresAt |
string, or number, or null | ||
(shape 2).page.mfa.publishedDids.dids[].preferred |
boolean | ||
(shape 2).page.mfa.publishedDids.dids[].proof |
string | ||
(shape 2).page.mfa.publishedDids.dids[].rid |
string | ||
(shape 2).page.mfa.publishedDids.dids[].state |
string | ||
(shape 2).page.mfa.publishedDids.dids[].versions |
list | ||
(shape 2).page.mfa.publishedDids.dids[].versions[].authorizedBy |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.publishedDids.dids[].versions[].change |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.publishedDids.dids[].versions[].created |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.publishedDids.dids[].versions[].keys |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.publishedDids.dids[].versions[].versionId |
object | Nested deeper than this page draws. | |
(shape 2).page.mfa.publishedDids.entryFound |
boolean | ||
(shape 2).page.mfa.publishedDids.maxPerPerson |
number | ||
(shape 2).page.mfa.publishedDids.publishing |
boolean | ||
(shape 2).page.mfa.publishedDids.user |
string | ||
(shape 2).page.mfa.recovery |
object | ||
(shape 2).page.mfa.recovery.count |
number | ||
(shape 2).page.mfa.recovery.enabled |
boolean | ||
(shape 2).page.mfa.recovery.groupSize |
number | ||
(shape 2).page.mfa.recovery.length |
number | ||
(shape 2).page.mfa.selfIssued |
object | ||
(shape 2).page.mfa.selfIssued.entryFound |
boolean | ||
(shape 2).page.mfa.selfIssued.maxPerPerson |
number | ||
(shape 2).page.mfa.selfIssued.signInEnabled |
boolean | ||
(shape 2).page.mfa.selfIssued.subjectSyntaxTypes |
list | ||
(shape 2).page.mfa.selfIssued.subjectSyntaxTypes[] |
string | ||
(shape 2).page.mfa.selfIssued.subjects |
list | ||
(shape 2).page.mfa.selfIssued.subjects[].by |
string | ||
(shape 2).page.mfa.selfIssued.subjects[].enrolledAt |
string, or number, or null | ||
(shape 2).page.mfa.selfIssued.subjects[].keyAlg |
string | ||
(shape 2).page.mfa.selfIssued.subjects[].label |
string | ||
(shape 2).page.mfa.selfIssued.subjects[].location |
object | ||
(shape 2).page.mfa.selfIssued.subjects[].location.kind |
string | ||
(shape 2).page.mfa.selfIssued.subjects[].location.value |
string | ||
(shape 2).page.mfa.selfIssued.subjects[].pinnedKeys |
list | ||
(shape 2).page.mfa.selfIssued.subjects[].pinnedKeys[] |
string | ||
(shape 2).page.mfa.selfIssued.subjects[].preferred |
boolean | ||
(shape 2).page.mfa.selfIssued.subjects[].proof |
string | ||
(shape 2).page.mfa.selfIssued.subjects[].provedAt |
string, or number, or null | ||
(shape 2).page.mfa.selfIssued.subjects[].subject |
string | ||
(shape 2).page.mfa.selfIssued.user |
string | ||
(shape 2).page.mfa.signing |
object | ||
(shape 2).page.mfa.signing.active |
number | ||
(shape 2).page.mfa.signing.caAvailable |
boolean | ||
(shape 2).page.mfa.signing.certificates |
list | ||
(shape 2).page.mfa.signing.certificates[].certificatePem |
string | ||
(shape 2).page.mfa.signing.certificates[].keyAlg |
string | ||
(shape 2).page.mfa.signing.certificates[].label |
string | ||
(shape 2).page.mfa.signing.certificates[].notAfter |
string, or number, or null | ||
(shape 2).page.mfa.signing.certificates[].notBefore |
string, or number, or null | ||
(shape 2).page.mfa.signing.certificates[].reason |
string, or null | ||
(shape 2).page.mfa.signing.certificates[].revokedAt |
string, or number, or null | ||
(shape 2).page.mfa.signing.certificates[].serialHex |
string | ||
(shape 2).page.mfa.signing.certificates[].state |
string | ||
(shape 2).page.mfa.signing.certificates[].subject |
string | ||
(shape 2).page.mfa.signing.certificates[].thumbprint |
string | ||
(shape 2).page.mfa.signing.defaultKeyAlg |
string | ||
(shape 2).page.mfa.signing.holder |
string | ||
(shape 2).page.mfa.signing.implicitName |
string | ||
(shape 2).page.mfa.signing.keyAlgorithms |
list | ||
(shape 2).page.mfa.signing.keyAlgorithms[] |
string | ||
(shape 2).page.mfa.signing.kind |
string | ||
(shape 2).page.mfa.signing.max |
number | ||
(shape 2).page.mfa.signing.ok |
boolean | ||
(shape 2).page.mfa.signing.passwordMin |
number | ||
(shape 2).page.mfa.signing.revocationReasons |
list | ||
(shape 2).page.mfa.signing.revocationReasons[] |
string | ||
(shape 2).page.mfa.storable |
boolean | ||
(shape 2).page.mfa.tls |
object | ||
(shape 2).page.mfa.tls.active |
number | ||
(shape 2).page.mfa.tls.caAvailable |
boolean | ||
(shape 2).page.mfa.tls.certificates |
list | ||
(shape 2).page.mfa.tls.certificates[].certificatePem |
string | ||
(shape 2).page.mfa.tls.certificates[].keyAlg |
string | ||
(shape 2).page.mfa.tls.certificates[].label |
string | ||
(shape 2).page.mfa.tls.certificates[].notAfter |
string, or number, or null | ||
(shape 2).page.mfa.tls.certificates[].notBefore |
string, or number, or null | ||
(shape 2).page.mfa.tls.certificates[].reason |
string, or null | ||
(shape 2).page.mfa.tls.certificates[].revokedAt |
string, or number, or null | ||
(shape 2).page.mfa.tls.certificates[].serialHex |
string | ||
(shape 2).page.mfa.tls.certificates[].state |
string | ||
(shape 2).page.mfa.tls.certificates[].subject |
string | ||
(shape 2).page.mfa.tls.certificates[].thumbprint |
string | ||
(shape 2).page.mfa.tls.defaultKeyAlg |
string | ||
(shape 2).page.mfa.tls.entryDn |
string | ||
(shape 2).page.mfa.tls.holder |
string | ||
(shape 2).page.mfa.tls.implicitName |
string | ||
(shape 2).page.mfa.tls.keyAlgorithms |
list | ||
(shape 2).page.mfa.tls.keyAlgorithms[] |
string | ||
(shape 2).page.mfa.tls.kind |
string | ||
(shape 2).page.mfa.tls.max |
number | ||
(shape 2).page.mfa.tls.ok |
boolean | ||
(shape 2).page.mfa.tls.passwordMin |
number | ||
(shape 2).page.mfa.tls.revocationReasons |
list | ||
(shape 2).page.mfa.tls.revocationReasons[] |
string | ||
(shape 2).page.mfa.tls.subjectDn |
string | ||
(shape 2).page.mfa.totp |
object | ||
(shape 2).page.mfa.totp.algorithm |
string | ||
(shape 2).page.mfa.totp.digits |
number | ||
(shape 2).page.mfa.totp.enabled |
boolean | ||
(shape 2).page.mfa.totp.enrolmentTtlMs |
number | ||
(shape 2).page.mfa.totp.issuer |
string | ||
(shape 2).page.mfa.totp.period |
number | ||
(shape 2).page.mfa.totp.secretBytes |
number | ||
(shape 2).page.mfa.totp.window |
number | ||
(shape 2).page.mfa.verifications |
object | ||
(shape 2).page.mfa.verifications.attestationTypes |
list | ||
(shape 2).page.mfa.verifications.attestationTypes[] |
string | ||
(shape 2).page.mfa.verifications.checkMethods |
list | ||
(shape 2).page.mfa.verifications.checkMethods[] |
string | ||
(shape 2).page.mfa.verifications.documentTypes |
list | ||
(shape 2).page.mfa.verifications.documentTypes[] |
string | ||
(shape 2).page.mfa.verifications.electronicRecordTypes |
list | ||
(shape 2).page.mfa.verifications.electronicRecordTypes[] |
string | ||
(shape 2).page.mfa.verifications.evidenceTypes |
list | ||
(shape 2).page.mfa.verifications.evidenceTypes[] |
string | ||
(shape 2).page.mfa.verifications.page |
integer | ||
(shape 2).page.mfa.verifications.pages |
integer | ||
(shape 2).page.mfa.verifications.paging |
object | ||
(shape 2).page.mfa.verifications.paging.firstRow |
integer | ||
(shape 2).page.mfa.verifications.paging.lastRow |
integer | ||
(shape 2).page.mfa.verifications.paging.noun |
string | ||
(shape 2).page.mfa.verifications.paging.page |
integer | ||
(shape 2).page.mfa.verifications.paging.pages |
integer | ||
(shape 2).page.mfa.verifications.paging.param |
string | ||
(shape 2).page.mfa.verifications.paging.perPage |
integer | ||
(shape 2).page.mfa.verifications.paging.total |
integer | ||
(shape 2).page.mfa.verifications.perPage |
integer | ||
(shape 2).page.mfa.verifications.total |
integer | ||
(shape 2).page.mfa.verifications.trustFrameworks |
list | ||
(shape 2).page.mfa.verifications.trustFrameworks[] |
string | ||
(shape 2).page.mfa.verifications.user |
string | ||
(shape 2).page.mfa.verifications.verifiableClaims |
list | ||
(shape 2).page.mfa.verifications.verifiableClaims[] |
string | ||
(shape 2).page.mfa.verifications.verifications |
list | ||
(shape 2).page.mfa.verifications.verifications[].by |
string | ||
(shape 2).page.mfa.verifications.verifications[].claims |
any JSON | The verified claims and their values, as the OpenID Connect claim each is: a string for most, an object for address, a list for nationalities. The verified claims and their values, as the OpenID Connect claim each is: a string for most, an object for address, a list for nationalities. |
|
(shape 2).page.mfa.verifications.verifications[].id |
string | ||
(shape 2).page.mfa.verifications.verifications[].recorded |
string, or number, or null | ||
(shape 2).page.mfa.verifications.verifications[].source |
string | ||
(shape 2).page.mfa.verifications.verifications[].verification |
any JSON | The OpenID Connect for Identity Assurance verification element: a caller may post it whole as JSON, and a wallet or a certificate may supply it, so its evidence is that specification’s to shape. The OpenID Connect for Identity Assurance verification element: a caller may post it whole as JSON, and a wallet or a certificate may supply it, so its evidence is that specification’s to shape. |
|
(shape 2).page.mfa.webauthn |
object | ||
(shape 2).page.mfa.webauthn.algorithms |
list | ||
(shape 2).page.mfa.webauthn.algorithms[] |
string | ||
(shape 2).page.mfa.webauthn.attestation |
string | ||
(shape 2).page.mfa.webauthn.authenticatorAttachment |
string | ||
(shape 2).page.mfa.webauthn.credProps |
boolean | ||
(shape 2).page.mfa.webauthn.enabled |
boolean | ||
(shape 2).page.mfa.webauthn.hints |
list | ||
(shape 2).page.mfa.webauthn.hints[] |
string | ||
(shape 2).page.mfa.webauthn.insecureAlgorithms |
boolean | ||
(shape 2).page.mfa.webauthn.maxKeysPerPerson |
number | ||
(shape 2).page.mfa.webauthn.mfaAllowed |
boolean | ||
(shape 2).page.mfa.webauthn.minPinLength |
boolean, or number, or null | ||
(shape 2).page.mfa.webauthn.pqcAlongsideClassical |
boolean | ||
(shape 2).page.mfa.webauthn.pqcOnly |
boolean | ||
(shape 2).page.mfa.webauthn.primaryAllowed |
boolean | ||
(shape 2).page.mfa.webauthn.residentKey |
string | ||
(shape 2).page.mfa.webauthn.rpId |
string | ||
(shape 2).page.mfa.webauthn.rpName |
string | ||
(shape 2).page.mfa.webauthn.timeoutMs |
number | ||
(shape 2).page.mfa.webauthn.userVerification |
string | ||
(shape 2).page.mfa.webauthn.usernameless |
boolean | ||
(shape 2).page.params |
map | ||
(shape 2).page.params.{key} |
list, or string, or number, or boolean, or null | ||
(shape 2).page.params.{key}[] |
string, or number, or boolean, or null | ||
(shape 2).page.perPage |
number | ||
(shape 2).page.riskAsked |
boolean | ||
(shape 2).page.serviceAccountRules |
object | ||
(shape 2).page.serviceAccountRules.dn |
string | ||
(shape 2).page.serviceAccountRules.maxOwners |
number | ||
(shape 2).page.serviceAccountRules.requiresOwner |
boolean | ||
(shape 2).page.serviceProviders |
list | ||
(shape 2).page.serviceProviders[].fedId |
string | ||
(shape 2).page.serviceProviders[].fedPeer |
string | ||
(shape 2).risk |
object | ||
(shape 2).risk.crossedAt |
number | ||
(shape 2).risk.lastAssessment |
string | ||
(shape 2).risk.level |
string | ||
(shape 2).risk.previousLevel |
string | ||
(shape 2).risk.reason |
string | ||
(shape 2).risk.score |
number | ||
(shape 2).risk.subject |
string | ||
(shape 2).risk.updatedAt |
number | ||
(shape 2).serviceAccount |
object | ||
(shape 2).serviceAccount.destination |
string, or null | ||
(shape 2).serviceAccount.owners |
list | ||
(shape 2).serviceAccount.owners[].dn |
string | ||
(shape 2).serviceAccount.owners[].kind |
string | ||
(shape 2).serviceAccount.owners[].name |
string | ||
(shape 2).serviceAccount.owners[].present |
boolean | ||
(shape 2).serviceAccount.ownership |
object | ||
(shape 2).serviceAccount.ownership.kind |
string | ||
(shape 2).serviceAccount.ownership.marked |
boolean | ||
(shape 2).serviceAccount.ownership.name |
string | ||
(shape 2).serviceAccount.ownership.protected |
boolean | ||
(shape 2).serviceAccount.ownership.reasons |
list | ||
(shape 2).serviceAccount.ownership.reasons[] |
string | ||
(shape 2).serviceAccount.policy |
object | ||
(shape 2).serviceAccount.policy.allowBrowserSignIn |
boolean | ||
(shape 2).serviceAccount.policy.doors |
list | ||
(shape 2).serviceAccount.policy.doors[] |
string | ||
(shape 2).serviceAccount.policy.exemptFromSecondFactor |
boolean | ||
(shape 2).serviceAccount.policy.from |
string | ||
(shape 2).serviceAccount.policy.name |
string, or null | ||
(shape 2).serviceAccount.policy.requiresOwner |
boolean | ||
(shape 2).serviceAccount.previousPasswordUntil |
string, or null | ||
(shape 2).serviceAccount.rotatedAt |
string, or null | ||
(shape 2).serviceAccount.rotation |
object | ||
(shape 2).serviceAccount.rotation.alarm |
boolean | ||
(shape 2).serviceAccount.rotation.enabled |
boolean | ||
(shape 2).serviceAccount.rotation.failures |
number | ||
(shape 2).serviceAccount.rotation.lastAttemptAt |
string, or null | ||
(shape 2).serviceAccount.rotation.lastError |
string, or null | ||
(shape 2).serviceAccount.rotation.nextDueAt |
string, or null | ||
(shape 2).serviceAccount.rotation.rotates |
boolean | ||
(shape 2).serviceAccount.secretName |
string, or null | ||
(shape 2).serviceAccount.username |
string | ||
(shape 2).sessions |
list | ||
(shape 2).sessions[].accountSet |
string | ||
(shape 2).sessions[].acr |
string | ||
(shape 2).sessions[].amr |
string | ||
(shape 2).sessions[].authTime |
number | ||
(shape 2).sessions[].authentications |
number | ||
(shape 2).sessions[].deviceBound |
object | ||
(shape 2).sessions[].deviceBound.alg |
string | ||
(shape 2).sessions[].deviceBound.bound |
boolean | ||
(shape 2).sessions[].deviceBound.boundAt |
number | ||
(shape 2).sessions[].deviceBound.fact |
string | ||
(shape 2).sessions[].deviceBound.reasons |
list | ||
(shape 2).sessions[].deviceBound.reasons[] |
string | ||
(shape 2).sessions[].deviceBound.refreshedAt |
number | ||
(shape 2).sessions[].deviceBound.refreshes |
number | ||
(shape 2).sessions[].expired |
boolean | ||
(shape 2).sessions[].expires |
number | ||
(shape 2).sessions[].id |
string | ||
(shape 2).sessions[].startedAt |
number | ||
(shape 2).sessions[].sub |
string | ||
(shape 2).sessions[].tokens |
list | ||
(shape 2).sessions[].tokens[].audience |
string | ||
(shape 2).sessions[].tokens[].client_id |
list, or string | ||
(shape 2).sessions[].tokens[].client_id[] |
string | ||
(shape 2).sessions[].tokens[].exp |
number | ||
(shape 2).sessions[].tokens[].grant |
string | ||
(shape 2).sessions[].tokens[].grantId |
string | ||
(shape 2).sessions[].tokens[].grantRefresh |
boolean | ||
(shape 2).sessions[].tokens[].iat |
number | ||
(shape 2).sessions[].tokens[].iss |
string | ||
(shape 2).sessions[].tokens[].issuedAt |
number | ||
(shape 2).sessions[].tokens[].jkt |
string | ||
(shape 2).sessions[].tokens[].jti |
string | ||
(shape 2).sessions[].tokens[].key |
string | ||
(shape 2).sessions[].tokens[].kind |
string | ||
(shape 2).sessions[].tokens[].length |
number | ||
(shape 2).sessions[].tokens[].nbf |
number | ||
(shape 2).sessions[].tokens[].revocable |
boolean | ||
(shape 2).sessions[].tokens[].revoked |
boolean | ||
(shape 2).sessions[].tokens[].revokedAt |
number | ||
(shape 2).sessions[].tokens[].revokedVia |
string | ||
(shape 2).sessions[].tokens[].scope |
list, or string | ||
(shape 2).sessions[].tokens[].scope[] |
string | ||
(shape 2).sessions[].tokens[].sessionAuthenticated |
boolean | ||
(shape 2).sessions[].tokens[].sessionId |
string | ||
(shape 2).sessions[].tokens[].setId |
string | ||
(shape 2).sessions[].tokens[].state |
string | ||
(shape 2).sessions[].tokens[].sub |
string | ||
(shape 2).sessions[].tokens[].typ |
string | ||
(shape 2).sessions[].tokens[].username |
string | ||
(shape 2).sessions[].tokens[].x5t |
string | ||
(shape 2).sessions[].tokens[].x5tSpki |
string | ||
(shape 2).sessions[].tokensPaging |
object | ||
(shape 2).sessions[].tokensPaging.firstRow |
integer | ||
(shape 2).sessions[].tokensPaging.lastRow |
integer | ||
(shape 2).sessions[].tokensPaging.noun |
string | ||
(shape 2).sessions[].tokensPaging.page |
integer | ||
(shape 2).sessions[].tokensPaging.pages |
integer | ||
(shape 2).sessions[].tokensPaging.param |
string | ||
(shape 2).sessions[].tokensPaging.perPage |
integer | ||
(shape 2).sessions[].tokensPaging.total |
integer | ||
(shape 2).sessions[].username |
string | ||
(shape 2).sessions[].wsfedRealms |
list | ||
(shape 2).sessions[].wsfedRealms[] |
string | ||
(shape 2).sessionsPaging |
object | ||
(shape 2).sessionsPaging.firstRow |
integer | ||
(shape 2).sessionsPaging.lastRow |
integer | ||
(shape 2).sessionsPaging.noun |
string | ||
(shape 2).sessionsPaging.page |
integer | ||
(shape 2).sessionsPaging.pages |
integer | ||
(shape 2).sessionsPaging.param |
string | ||
(shape 2).sessionsPaging.perPage |
integer | ||
(shape 2).sessionsPaging.total |
integer | ||
(shape 2).subject |
string | ||
(shape 2).tokensOnEndedSessions |
list | ||
(shape 2).tokensOnEndedSessions[].audience |
string | ||
(shape 2).tokensOnEndedSessions[].client_id |
list, or string | ||
(shape 2).tokensOnEndedSessions[].client_id[] |
string | ||
(shape 2).tokensOnEndedSessions[].exp |
number | ||
(shape 2).tokensOnEndedSessions[].grant |
string | ||
(shape 2).tokensOnEndedSessions[].grantId |
string | ||
(shape 2).tokensOnEndedSessions[].grantRefresh |
boolean | ||
(shape 2).tokensOnEndedSessions[].iat |
number | ||
(shape 2).tokensOnEndedSessions[].iss |
string | ||
(shape 2).tokensOnEndedSessions[].issuedAt |
number | ||
(shape 2).tokensOnEndedSessions[].jkt |
string | ||
(shape 2).tokensOnEndedSessions[].jti |
string | ||
(shape 2).tokensOnEndedSessions[].key |
string | ||
(shape 2).tokensOnEndedSessions[].kind |
string | ||
(shape 2).tokensOnEndedSessions[].length |
number | ||
(shape 2).tokensOnEndedSessions[].nbf |
number | ||
(shape 2).tokensOnEndedSessions[].revocable |
boolean | ||
(shape 2).tokensOnEndedSessions[].revoked |
boolean | ||
(shape 2).tokensOnEndedSessions[].revokedAt |
number | ||
(shape 2).tokensOnEndedSessions[].revokedVia |
string | ||
(shape 2).tokensOnEndedSessions[].scope |
list, or string | ||
(shape 2).tokensOnEndedSessions[].scope[] |
string | ||
(shape 2).tokensOnEndedSessions[].sessionAuthenticated |
boolean | ||
(shape 2).tokensOnEndedSessions[].sessionId |
string | ||
(shape 2).tokensOnEndedSessions[].setId |
string | ||
(shape 2).tokensOnEndedSessions[].state |
string | ||
(shape 2).tokensOnEndedSessions[].sub |
string | ||
(shape 2).tokensOnEndedSessions[].typ |
string | ||
(shape 2).tokensOnEndedSessions[].username |
string | ||
(shape 2).tokensOnEndedSessions[].x5t |
string | ||
(shape 2).tokensOnEndedSessions[].x5tSpki |
string | ||
(shape 2).tokensOnEndedSessionsPaging |
object | ||
(shape 2).tokensOnEndedSessionsPaging.firstRow |
integer | ||
(shape 2).tokensOnEndedSessionsPaging.lastRow |
integer | ||
(shape 2).tokensOnEndedSessionsPaging.noun |
string | ||
(shape 2).tokensOnEndedSessionsPaging.page |
integer | ||
(shape 2).tokensOnEndedSessionsPaging.pages |
integer | ||
(shape 2).tokensOnEndedSessionsPaging.param |
string | ||
(shape 2).tokensOnEndedSessionsPaging.perPage |
integer | ||
(shape 2).tokensOnEndedSessionsPaging.total |
integer | ||
(shape 2).tokensWithNoSession |
list | ||
(shape 2).tokensWithNoSession[].audience |
string | ||
(shape 2).tokensWithNoSession[].client_id |
list, or string | ||
(shape 2).tokensWithNoSession[].client_id[] |
string | ||
(shape 2).tokensWithNoSession[].exp |
number | ||
(shape 2).tokensWithNoSession[].grant |
string | ||
(shape 2).tokensWithNoSession[].grantId |
string | ||
(shape 2).tokensWithNoSession[].grantRefresh |
boolean | ||
(shape 2).tokensWithNoSession[].iat |
number | ||
(shape 2).tokensWithNoSession[].iss |
string | ||
(shape 2).tokensWithNoSession[].issuedAt |
number | ||
(shape 2).tokensWithNoSession[].jkt |
string | ||
(shape 2).tokensWithNoSession[].jti |
string | ||
(shape 2).tokensWithNoSession[].key |
string | ||
(shape 2).tokensWithNoSession[].kind |
string | ||
(shape 2).tokensWithNoSession[].length |
number | ||
(shape 2).tokensWithNoSession[].nbf |
number | ||
(shape 2).tokensWithNoSession[].revocable |
boolean | ||
(shape 2).tokensWithNoSession[].revoked |
boolean | ||
(shape 2).tokensWithNoSession[].revokedAt |
number | ||
(shape 2).tokensWithNoSession[].revokedVia |
string | ||
(shape 2).tokensWithNoSession[].scope |
list, or string | ||
(shape 2).tokensWithNoSession[].scope[] |
string | ||
(shape 2).tokensWithNoSession[].sessionAuthenticated |
boolean | ||
(shape 2).tokensWithNoSession[].sessionId |
string | ||
(shape 2).tokensWithNoSession[].setId |
string | ||
(shape 2).tokensWithNoSession[].state |
string | ||
(shape 2).tokensWithNoSession[].sub |
string | ||
(shape 2).tokensWithNoSession[].typ |
string | ||
(shape 2).tokensWithNoSession[].username |
string | ||
(shape 2).tokensWithNoSession[].x5t |
string | ||
(shape 2).tokensWithNoSession[].x5tSpki |
string | ||
(shape 2).tokensWithNoSessionPaging |
object | ||
(shape 2).tokensWithNoSessionPaging.firstRow |
integer | ||
(shape 2).tokensWithNoSessionPaging.lastRow |
integer | ||
(shape 2).tokensWithNoSessionPaging.noun |
string | ||
(shape 2).tokensWithNoSessionPaging.page |
integer | ||
(shape 2).tokensWithNoSessionPaging.pages |
integer | ||
(shape 2).tokensWithNoSessionPaging.param |
string | ||
(shape 2).tokensWithNoSessionPaging.perPage |
integer | ||
(shape 2).tokensWithNoSessionPaging.total |
integer | ||
(shape 2).uma |
object | ||
(shape 2).uma.held |
list | ||
(shape 2).uma.held[].client |
string | ||
(shape 2).uma.held[].createdAt |
number | ||
(shape 2).uma.held[].exp |
number | ||
(shape 2).uma.held[].jti |
string | ||
(shape 2).uma.held[].permissions |
list, or string | ||
(shape 2).uma.held[].permissions[] |
string | ||
(shape 2).uma.held[].requestingParty |
string | ||
(shape 2).uma.held[].resourceServer |
string | ||
(shape 2).uma.held[].upgradedFrom |
string | ||
(shape 2).uma.pending |
list | ||
(shape 2).uma.pending[].client |
string | ||
(shape 2).uma.pending[].createdAt |
number | ||
(shape 2).uma.pending[].expiresAt |
number | ||
(shape 2).uma.pending[].id |
string | ||
(shape 2).uma.pending[].owner |
string | ||
(shape 2).uma.pending[].ownerKind |
string | ||
(shape 2).uma.pending[].permissions |
list, or string | ||
(shape 2).uma.pending[].permissions[] |
string | ||
(shape 2).uma.pending[].requester |
string | ||
(shape 2).uma.pending[].resourceServer |
string | ||
(shape 2).uma.pending[].state |
string | ||
(shape 2).uma.resources |
list | ||
(shape 2).uma.resources[].createdAt |
number | ||
(shape 2).uma.resources[].id |
string | ||
(shape 2).uma.resources[].name |
string | ||
(shape 2).uma.resources[].owner |
string | ||
(shape 2).uma.resources[].ownerKind |
string | ||
(shape 2).uma.resources[].resourceServer |
string | ||
(shape 2).uma.resources[].scopes |
list | ||
(shape 2).uma.resources[].scopes[] |
string | ||
(shape 2).uma.resources[].type |
string | ||
(shape 2).uma.shares |
list | ||
(shape 2).uma.shares[].acr |
string | ||
(shape 2).uma.shares[].askMe |
boolean | ||
(shape 2).uma.shares[].expires |
string | ||
(shape 2).uma.shares[].id |
string | ||
(shape 2).uma.shares[].recipient |
object | ||
(shape 2).uma.shares[].recipient.kind |
string | ||
(shape 2).uma.shares[].recipient.label |
string | ||
(shape 2).uma.shares[].recipient.value |
string | ||
(shape 2).uma.shares[].resourceId |
string | ||
(shape 2).uma.shares[].scopes |
list | ||
(shape 2).uma.shares[].scopes[] |
string | ||
(shape 2).uma.user |
string | ||
(shape 2).user |
object | ||
(shape 2).user.artifactKinds |
list | ||
(shape 2).user.artifactKinds[].count |
number | ||
(shape 2).user.artifactKinds[].kind |
string | ||
(shape 2).user.artifacts |
number | ||
(shape 2).user.authenticated |
boolean | ||
(shape 2).user.authentications |
number | ||
(shape 2).user.events |
list | ||
(shape 2).user.events[].acr |
string | ||
(shape 2).user.events[].address |
string | ||
(shape 2).user.events[].amr |
list, or string | ||
(shape 2).user.events[].amr[] |
string | ||
(shape 2).user.events[].at |
number | ||
(shape 2).user.events[].client_id |
string | ||
(shape 2).user.events[].method |
string | ||
(shape 2).user.events[].note |
string | ||
(shape 2).user.events[].presented |
string | ||
(shape 2).user.events[].protocol |
string | ||
(shape 2).user.events[].realm |
string | ||
(shape 2).user.events[].sessionId |
string | ||
(shape 2).user.events[].sub |
string | ||
(shape 2).user.eventsForgotten |
number | ||
(shape 2).user.firstAt |
number | ||
(shape 2).user.forms |
list | ||
(shape 2).user.forms[].count |
number | ||
(shape 2).user.forms[].form |
string | ||
(shape 2).user.isClient |
boolean | ||
(shape 2).user.key |
string | ||
(shape 2).user.knownBy |
string | ||
(shape 2).user.lastActivityAt |
number | ||
(shape 2).user.lastAt |
number | ||
(shape 2).user.name |
string | ||
(shape 2).user.protocols |
list | ||
(shape 2).user.protocols[].count |
number | ||
(shape 2).user.protocols[].firstAt |
number | ||
(shape 2).user.protocols[].lastAt |
number | ||
(shape 2).user.protocols[].methods |
list | ||
(shape 2).user.protocols[].methods[].count |
number | ||
(shape 2).user.protocols[].methods[].method |
string | ||
(shape 2).user.protocols[].protocol |
string | ||
(shape 2).user.realms |
list | ||
(shape 2).user.realms[].count |
number | ||
(shape 2).user.realms[].realm |
string | ||
(shape 2).user.tokens |
object | ||
(shape 2).user.tokens.expired |
number | ||
(shape 2).user.tokens.issued |
number | ||
(shape 2).user.tokens.other |
number | ||
(shape 2).user.tokens.revoked |
number | ||
(shape 2).user.tokens.valid |
number | ||
(shape 3) |
object | ||
(shape 3).known |
boolean | ||
(shape 3).registryKeeps |
number | ||
(shape 3).user |
string |
400: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/users/add-attribute
addUserAttributeValue
Add a value to one of somebody’s multi-valued attributes
One attribute of the person’s directory entry, written in place, as an ldapmodify of it would be. The attributes it takes are the person schema (person, organizationalPerson, inetOrgPerson and the Identity Assurance claims) and the credential catalogue, less what is managed: userPassword (set-password), the binary ones, uid, mail (set-mail, which verifies it) and whichever attribute names the entry. attributeEditor in GET /admin-api/users?user= lists them, with what each holds and the shape its value must have. A change is told to Shared Signals as a SCIM or LDAP write of it is.
add appends value, and is refused on an attribute that holds one value (displayName, employeeNumber, preferredLanguage, c, schacDateOfBirth, and this service’s own single-fact attributes) and for a value already held.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
attribute |
string | yes | The attribute, as attributeEditor.attributes[].name in GET /admin-api/users?user= names it. |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
|
value |
string | yes | The value to add. |
200: The attribute and every value it now holds.
| Member | Type | Required | What it is |
|---|---|---|---|
attribute |
string | ||
dn |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
mode |
string | ||
ok |
boolean | yes | |
reason |
string | ||
values |
list | ||
values[] |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
attribute |
string | ||
dn |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
mode |
string | ||
ok |
boolean | yes | |
reason |
string | ||
values |
list | ||
values[] |
string |
POST /admin-api/users/add-certificate
addUserCertificate
Store a certificate on somebody’s entry, so an outside certificate authority’s certificate signs them in
Stores one X.509 certificate in the person’s userCertificate (RFC 4523; written as userCertificate;binary). A certificate from an outside certificate authority — one trusted through the Client Truststores — is an identity at a door that reads a client certificate as a person (/tls/sign-in, the sign-in screen, SCIM, the XACML gates, Shared Signals, WS-Trust, LDAP SASL EXTERNAL) only while it is stored, byte for byte, on exactly one entry of the realm: never by its common name or subject (#1061). Refused when it is already stored on another entry (STS-ADMIN-0899) or the person has no entry (STS-ADMIN-0898). A renewed certificate is stored again.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
certificate |
string | yes | The leaf, as one PEM block or base64 DER. |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The certificates the entry stores now.
| Member | Type | Required | What it is |
|---|---|---|---|
certificates |
list | ||
certificates[].expired |
boolean | ||
certificates[].issuer |
string | ||
certificates[].notAfter |
string | ||
certificates[].notBefore |
string | ||
certificates[].readable |
boolean | ||
certificates[].serialNumber |
string | ||
certificates[].sha256 |
string | ||
certificates[].subject |
string | ||
changed |
boolean | ||
dn |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
rule |
string | ||
sha256 |
string | ||
user |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
certificates |
list | ||
certificates[].expired |
boolean | ||
certificates[].issuer |
string | ||
certificates[].notAfter |
string | ||
certificates[].notBefore |
string | ||
certificates[].readable |
boolean | ||
certificates[].serialNumber |
string | ||
certificates[].sha256 |
string | ||
certificates[].subject |
string | ||
changed |
boolean | ||
dn |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
rule |
string | ||
sha256 |
string | ||
user |
string |
POST /admin-api/users/add-service-account-owner
addServiceAccountOwner
Add one owner to a service account
Adds a person or group of this realm to the service account’s owners (#600, #602) and writes at once, keeping the other owners and the push destination. owner is a DN, a username or a group’s cn. An owner already listed is ok with changed: false; more than 25 is refused.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
owner |
string | yes | The person or group to add. |
user |
string | yes | The service account, as /admin-api/users names it. |
username |
string | Accepted for user. |
200: The account as it now stands (account), and whether it changed.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
object | ||
account.destination |
string | ||
account.dn |
string | ||
account.ownerProtected |
boolean | ||
account.owners |
list | ||
account.owners[].dn |
string | ||
account.owners[].kind |
string | ||
account.owners[].name |
string | ||
account.owners[].present |
boolean | ||
account.policy |
string | ||
account.previousPasswordExpires |
number | ||
account.rotatedAt |
string | ||
account.rotation |
object | ||
account.rotation.failures |
number | ||
account.rotation.lastAttempt |
number | ||
account.rotation.lastError |
string | ||
account.secretName |
string | ||
account.serviceAccount |
boolean | ||
account.username |
string | ||
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
object | ||
account.destination |
string | ||
account.dn |
string | ||
account.ownerProtected |
boolean | ||
account.owners |
list | ||
account.owners[].dn |
string | ||
account.owners[].kind |
string | ||
account.owners[].name |
string | ||
account.owners[].present |
boolean | ||
account.policy |
string | ||
account.previousPasswordExpires |
number | ||
account.rotatedAt |
string | ||
account.rotation |
object | ||
account.rotation.failures |
number | ||
account.rotation.lastAttempt |
number | ||
account.rotation.lastError |
string | ||
account.secretName |
string | ||
account.serviceAccount |
boolean | ||
account.username |
string | ||
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
POST /admin-api/users/answer-ciba-request
answerUserCibaRequest
Approve or deny a CIBA request waiting for somebody (development test control)
Answers an OpenID Connect CIBA backchannel authentication request waiting for the person, as they would on /portal/ciba: approve true or false, and an optional acr recorded as the level the approval reached. A ping or push client is notified as it would be. DEVELOPMENT ONLY: refused in product mode, where only the person answers.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
acr |
string | The level the approval is recorded as reaching. | |
approve |
boolean | yes | true approves, false denies. |
id |
string | yes | The request’s auth_req_id. |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The request’s state.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
state |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
state |
string | ||
username |
string |
GET /admin-api/users/app-passwords
getUserAppPasswords
One person’s app passwords, and which password-only doors refuse their own password
Each app password the person holds — its public id, name, the doors it is accepted at, when it was made and by whom, and when and where it was last used. Never the password and never its hash. Beside them, passwordOnlyDoors says which of the five doors refuse this person’s own password (in product mode, while they hold or must hold a second factor, less authn.passwordAloneDoors), and doors is the catalogue a scope is chosen from.
Mirrors GET /admin/users on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
username |
query | string | The older spelling of user, read when user is absent. |
|
user |
query | string | yes | The person, as /admin-api/users names them. |
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 app passwords and its paging.
| Member | Type | Required | What it is |
|---|---|---|---|
doors |
list | ||
doors[].id |
string | ||
doors[].label |
string | ||
doors[].what |
string | ||
enabled |
boolean | ||
maxPerPerson |
number | ||
page |
integer | ||
pages |
integer | ||
paging |
object | ||
paging.firstRow |
integer | ||
paging.lastRow |
integer | ||
paging.noun |
string | ||
paging.page |
integer | ||
paging.pages |
integer | ||
paging.param |
string | ||
paging.perPage |
integer | ||
paging.total |
integer | ||
passwordOnlyDoors |
object | ||
passwordOnlyDoors.accepted |
list | ||
passwordOnlyDoors.accepted[] |
string | ||
passwordOnlyDoors.passwordAloneDoors |
list | ||
passwordOnlyDoors.passwordAloneDoors[] |
string | ||
passwordOnlyDoors.refused |
list | ||
passwordOnlyDoors.refused[] |
string | ||
passwordOnlyDoors.secondFactor |
boolean | ||
passwordOnlyDoors.sentence |
string | ||
passwords |
list | ||
passwords[].createdAt |
number | ||
passwords[].createdBy |
string | ||
passwords[].doorLabels |
list | ||
passwords[].doorLabels[] |
string | ||
passwords[].doors |
list | ||
passwords[].doors[] |
string | ||
passwords[].id |
string | ||
passwords[].lastUsedAt |
number | ||
passwords[].lastUsedDoor |
string | ||
passwords[].name |
string | ||
perPage |
integer | ||
total |
integer | ||
unreadable |
boolean | ||
user |
string |
400: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/users/begin-passkey-enrolment
beginUserPasskeyEnrolment
Begin enrolling a passkey for somebody, in your own browser
Mints a WebAuthn registration challenge bound to YOU (the access token’s subject, which must be a person), the person and the lane, held for five minutes at most and usable once, and answers the ceremony your browser runs (ceremony): the challenge, the realm’s RP ID, the PERSON’s user handle (user.id, per lane, #643) with their name and display name (the passkey policy’s userDisplayName), the credentials to exclude (the person’s keys in that lane) and options — the algorithms offered in order and the realm’s attestation, user verification, resident key, hints and timeout. Every byte string is base64url.
Refused unless the person’s passkey policy’s adminEnrolment is on (STS-AUTHN-0440, off by default), the person is in this realm’s directory (STS-AUTHN-0441), the caller is a person (STS-AUTHN-0445), the realm accepts a passkey at all (STS-AUTHN-0531), and the lane and webauthn.maxKeysPerPerson allow it. No role is asked: a passkey has none since #1135, and the realm decides at each sign-in how it is used. There is no import of a registration made elsewhere.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
kind |
one of passkey, security-key |
Which kind of authenticator to ask for; the realm’s attachment setting decides either way. | |
lane |
one of classical, pqc |
The lane (#643) where the realm offers both (webauthn.pqcAlongsideClassical); the classical one otherwise. | |
role |
string | Ignored since #1135: a passkey has no role. Accepted so that an older body is not refused. | |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: enrolmentId, expiresAt, lane, kind and ceremony, or why it was not begun.
| Member | Type | Required | What it is |
|---|---|---|---|
ceremony |
object | ||
ceremony.challenge |
string | ||
ceremony.exclude |
list | ||
ceremony.exclude[] |
string | ||
ceremony.options |
object | ||
ceremony.options.algorithms |
list | ||
ceremony.options.algorithms[] |
number | ||
ceremony.options.attestation |
string | ||
ceremony.options.authenticatorSelection |
object | ||
ceremony.options.authenticatorSelection.authenticatorAttachment |
string | ||
ceremony.options.authenticatorSelection.requireResidentKey |
boolean | ||
ceremony.options.authenticatorSelection.residentKey |
string | ||
ceremony.options.authenticatorSelection.userVerification |
string | ||
ceremony.options.credProps |
boolean | ||
ceremony.options.hints |
list | ||
ceremony.options.hints[] |
string | ||
ceremony.options.minPinLength |
boolean | ||
ceremony.options.rp |
object | ||
ceremony.options.rp.id |
string | ||
ceremony.options.rp.name |
string | ||
ceremony.options.timeout |
number | ||
ceremony.rpId |
string | ||
ceremony.user |
object | ||
ceremony.user.displayName |
string | ||
ceremony.user.id |
string | ||
ceremony.user.name |
string | ||
enrolmentId |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresAt |
string, or number, or null | ||
kind |
string | ||
lane |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
ceremony |
object | ||
ceremony.challenge |
string | ||
ceremony.exclude |
list | ||
ceremony.exclude[] |
string | ||
ceremony.options |
object | ||
ceremony.options.algorithms |
list | ||
ceremony.options.algorithms[] |
number | ||
ceremony.options.attestation |
string | ||
ceremony.options.authenticatorSelection |
object | ||
ceremony.options.authenticatorSelection.authenticatorAttachment |
string | ||
ceremony.options.authenticatorSelection.requireResidentKey |
boolean | ||
ceremony.options.authenticatorSelection.residentKey |
string | ||
ceremony.options.authenticatorSelection.userVerification |
string | ||
ceremony.options.credProps |
boolean | ||
ceremony.options.hints |
list | ||
ceremony.options.hints[] |
string | ||
ceremony.options.minPinLength |
boolean | ||
ceremony.options.rp |
object | ||
ceremony.options.rp.id |
string | ||
ceremony.options.rp.name |
string | ||
ceremony.options.timeout |
number | ||
ceremony.rpId |
string | ||
ceremony.user |
object | ||
ceremony.user.displayName |
string | ||
ceremony.user.id |
string | ||
ceremony.user.name |
string | ||
enrolmentId |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresAt |
string, or number, or null | ||
kind |
string | ||
lane |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
POST /admin-api/users/begin-passkey-upgrade
beginUserPasskeyUpgrade
Begin upgrading a person’s classical passkey
Mints a one-use assertion challenge for the named classical passkey. The passkey must be present in the administrator’s browser to continue.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
credentialId |
string | yes | |
user |
string | yes |
200: The upgrade id and assertion ceremony.
| Member | Type | Required | What it is |
|---|---|---|---|
ceremony |
object | ||
ceremony.allow |
string | ||
ceremony.challenge |
string | ||
ceremony.options |
object | ||
ceremony.options.userVerification |
string | ||
ceremony.rpId |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
reason |
string | ||
upgradeId |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
ceremony |
object | ||
ceremony.allow |
string | ||
ceremony.challenge |
string | ||
ceremony.options |
object | ||
ceremony.options.userVerification |
string | ||
ceremony.rpId |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
reason |
string | ||
upgradeId |
string |
POST /admin-api/users/cancel-passkey-upgrade
cancelUserPasskeyUpgrade
Cancel a person’s pending passkey upgrade
Discards the pending one-use upgrade ceremony.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
user |
string | yes |
200: Whether the pending upgrade was cancelled.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
GET /admin-api/users/certificates
getUserCertificates
The certificates stored on one person’s entry (userCertificate)
Each certificate stored in the person’s userCertificate: the SHA-256 of its DER, its subject, issuer, serial and validity. A certificate from an outside certificate authority signs its holder in only as the one entry storing it (#1061).
Mirrors GET /admin/users on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
user |
query | string | yes | The person, as /admin-api/users names them. |
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 stored certificates.
| Member | Type | Required | What it is |
|---|---|---|---|
certificates |
list | ||
certificates[].expired |
boolean | ||
certificates[].issuer |
string | ||
certificates[].notAfter |
string | ||
certificates[].notBefore |
string | ||
certificates[].readable |
boolean | ||
certificates[].serialNumber |
string | ||
certificates[].sha256 |
string | ||
certificates[].subject |
string | ||
dn |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
rule |
string | ||
user |
string |
POST /admin-api/users/clear-backup-codes
clearUserBackupCodes
Clear somebody’s recovery codes
THE ONLY ROUTE TO A SECOND SET. A set is issued automatically, and ONCE, the first time somebody asks for one from the user portal; does nothing while a set exists, so clearing is what lets the next enrolment issue one.
It cannot lock anybody out — a recovery code is never a way in on its own — but it removes the way BACK, so somebody whose set is cleared and who then loses their phone needs an operator again.
There is no operation that READS the codes and there will not be. They are a working second factor; GET /users reports how many remain and never what they are. The person reads their own set back on /portal/mfa, which is the only place in this service that shows one.
Clearing a set nobody holds answers 400 rather than 200, for clear-totp’s reason.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
evidence |
string | How the person’s identity was verified, in at least 8 characters. Product mode requires it, and it is recorded in the audit log. | |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: Whose set was cleared. sessionsEnded counts the sessions a recovery code signed in, which were ended (#722); every other stays.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
remaining |
number | ||
sessionsEnded |
number | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
remaining |
number | ||
sessionsEnded |
number | ||
username |
string |
POST /admin-api/users/clear-email-factor
clearUserEmailFactor
Turn off somebody’s emailed second factor
Clears stsMailFactor — the emailed code or link the person opted into on /portal/mfa. It cannot lock anybody out: it is a second factor. There is no operation that turns it ON: the opt-in is the person’s. removed: false means they had none.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
evidence |
string | How the person’s identity was verified, in at least 8 characters. Product mode requires it, and it is recorded in the audit log. | |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: Whether a factor was turned off. sessionsEnded counts the sessions the emailed second factor signed in, which were ended (#722); every other stays.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
removed |
boolean | ||
sessionsEnded |
number |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
removed |
boolean | ||
sessionsEnded |
number |
POST /admin-api/users/clear-key
clearUserSecurityKey
Remove one of somebody’s security keys
Goes through the same removeKey() the person’s own portal calls, which is what carries the refusal that matters: it will not remove the last way in. A person with no password whose only PRIMARY key this is would be locked out by an operator’s call, and an operator must not be able to do what the owner is stopped from doing.
The credential id is the base64url one on this person’s factors.keys, on GET /admin-api/mfa’s rows, and on /portal/keys.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
credentialId |
string | yes | base64url, as WebAuthn produced it. |
evidence |
string | How the person’s identity was verified, in at least 8 characters. Product mode requires it, and it is recorded in the audit log. | |
user |
string | yes | |
username |
string | Accepted for user. |
200: Whether the key was removed, or why it was not. sessionsEnded counts the sessions the key signed in, which were ended (#722); every other stays.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
remaining |
number | ||
sessionsEnded |
number | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
remaining |
number | ||
sessionsEnded |
number | ||
username |
string |
POST /admin-api/users/clear-totp
clearUserAuthenticatorApp
Clear somebody’s authenticator app enrolment
THE ONLY WAY BACK FOR SOMEBODY WHO HAS LOST THEIR PHONE. The shared secret lives on that device and this service cannot reach it, and there is deliberately no self-service reset anywhere — a second factor anybody can remove is not a second factor.
It CANNOT lock anybody out: a one-time code is never a primary credential here, so clearing one drops the account to one factor rather than to none. The person sets a new one up at /portal/mfa.
Clearing an enrolment nobody holds answers 400 rather than 200: the caller asked to clear a specific thing and it was not there.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
evidence |
string | How the person’s identity was verified, in at least 8 characters. Product mode requires it, and it is recorded in the audit log. | |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: Whose enrolment was cleared. sessionsEnded counts the sessions the app’s codes signed in, which were ended (#722); every other stays.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
remaining |
number | ||
sessionsEnded |
number | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
remaining |
number | ||
sessionsEnded |
number | ||
username |
string |
POST /admin-api/users/create
createUser
Put a person in the directory before they authenticate
An entry under ou=users usually appears because somebody AUTHENTICATED — at either sign-in screen, on a password grant, with a UsernameToken, in a Kerberos AS-REQ. This is how to get one in ahead of that, which is what a client testing claims from the directory needs: the entry carries the invented person behind that name, so a credential issued for them and an ldapsearch for the entry say the same thing from the start.
One entry per person, and this is one of three doors onto that rule. A username already here is refused with the DN that holds it — whatever protocol brought them, and whichever attribute their entry is named by, since a person whose entry was created by a client certificate is at cn=<name>,ou=users rather than uid=<name>,ou=users. An ldapadd under ou=users gets the same refusal as LDAP_ENTRY_ALREADY_EXISTS (68), because all three call one function.
No password is set unless one is ASKED FOR through credential below. That default is what this operation has always done and is right in development mode, where no password is checked here in this protocol or any other; in product mode a person with no credential cannot sign in, and activation is how they are given one. Creating the entry does not put the name in GET /admin-api/users: that lists identities this service has SEEN authenticate, and this writes what the directory HOLDS.
SINCE 2026-09-06 IT TAKES THE PERSON’S DETAILS AND A CREDENTIAL, which is what the console’s /admin/users/new form posts. attributes are checked against the catalogue GET /admin-api/users/new publishes and an unknown name is REFUSED rather than dropped; invent decides whether the rest are made up, and it DEFAULTS TO TRUE so that a caller written before this gets exactly what it always got.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
attributes |
object | What is known about them, as {attribute: value}. The names are the catalogue GET /admin-api/users/new publishes, in that document’s own spelling, and they are the names the entry carries — so an ldapsearch shows exactly what was sent. A NAME THAT IS NOT ON THE CATALOGUE IS REFUSED and the whole create fails, rather than the value being ignored: silently dropping it would answer “created” to a request asking for something this did not do. userPassword is refused by that rule — use credential — and so is uid, which is username. An empty string is the same as sending nothing: the attribute is absent from the entry rather than present and empty. |
|
credential |
one of none, password, generate, activation |
How they first get in. generate is the DEFAULT since 2026-09-12: a password drawn to satisfy this realm’s password policy (GET /admin-api/policies), set, and RETURNED ONCE in password — this service stores a scrypt hash and cannot produce it again. It costs one hash per create, about 70ms, so a bulk load that wants nobody holding anything sends none. none was the default before, and in development mode it is enough to sign in, since no password is checked there; password, hashing the password field onto the entry, and refused by the password policy in product mode when it does not meet it; activation, issuing a single-use link and returning it ONCE in activationUrl for you to send them, at which they choose a password, a security key or both. A CREDENTIAL STEP THAT FAILS DOES NOT UNDO THE CREATE. A password can only be written onto an entry that exists, so the person is there either way; the reply is ok: true with credentialError set and says so, because answering ok: false would send a caller to create them again and meet “that username is taken”. |
|
deliver |
one of show, mail |
With credential: activation, mail (#63) sends the link to the address on the person’s entry through the realm’s mail transport and does NOT return it: the answer carries mailedTo. If it cannot be mailed the link is returned as with show (the default), with mailError saying why. |
|
destination |
string | With serviceAccount: the DN of the push destination (an application entry) its rotated password is written to. |
|
homeCell |
string | Only when this service is deployed as cells (#98): the id of the cell the person is homed in. Empty means the realm’s cells.homeCell, or the cell that answers. Another cell’s id makes the creation THERE; a cell the service does not have, or one in a jurisdiction the realm does not allow, is refused 400. Ignored in single-cell mode. |
|
invent |
boolean | Whether to MAKE UP the attributes not sent. Defaults to TRUE, which is what this operation has always done and what its own description above promises: vc_claims.js invents a consistent person per username, so the entry and any credential issued for them agree from the start. Send false for an entry carrying ONLY what you sent — its object classes, its uid, a description and your attributes. That is what the console’s form does. It is not a promise the entry stays that way: the Populate button on /admin/vc fills every missing SELECTED attribute on every person, and does not know which were typed. |
|
note |
string | Optional. What the entry’s description says about why it exists; the default says it was created by hand rather than by authenticating. An attributes.description wins over it, because an operator’s own sentence about a person is the more useful one and two values would be the entry answering the question twice. |
|
owners |
list | With serviceAccount: the people and groups answerable for it (#600) — each a DN, a username or a group’s cn; an array, or a string of one per line. At least one while the policy’s requireOwner is on (the default). |
|
owners[] |
string | ||
password |
string | Read only when credential is password. Hashed with scrypt by credentials.js and never stored or logged in the clear; nothing in this service can show it again. |
|
passwordConfirm |
string | Optional, and CHECKED WHERE SENT: the console’s form always sends it, because a mistyped password nobody can read back is a person who cannot sign in and nobody who can say why. An API caller with one value has nothing to mistype against and may omit it. | |
secretName |
string | With destination: the secret’s name or path there, which must already exist. |
|
serviceAccount |
boolean | Create the person as a SERVICE ACCOUNT (#221): a person entry carrying stsServiceAccount, governed by the realm’s service-account policy. owners, and destination with secretName, are read with it, and checked BEFORE the person is created — a refusal creates nobody. |
|
username |
string | yes | The name they will authenticate under — the same string that appears in a token’s sub and on /admin/users. Not a DN and not a did:, and it may not carry a character RFC 4514 reserves in a DN: those name entries that get here by being presented rather than by being created. |
200: The entry as created, in entry, with its dn; typed naming the attributes you sent and invented whether the rest were made up. A generated password is in password and an activation link in activationUrl — EACH RETURNED ONCE, because what is stored is a hash and this service cannot produce either again.
| Member | Type | Required | What it is |
|---|---|---|---|
activationLink |
string | ||
activationUrl |
string | ||
credential |
string | ||
credentialError |
string | ||
dn |
string | ||
entry |
object | ||
entry.attributes |
map | ||
entry.attributes.{key} |
list, or string | ||
entry.attributes.{key}[] |
string | ||
entry.createdAt |
string, or number, or null | ||
entry.dn |
string | ||
entry.members |
list | ||
entry.members[].attribute |
string | ||
entry.members[].cn |
string | ||
entry.members[].displayName |
string | ||
entry.members[].dn |
string | ||
entry.members[].holds |
string | ||
entry.members[].kind |
string | ||
entry.members[].mail |
string | ||
entry.members[].present |
boolean | ||
entry.members[].userKey |
string | ||
entry.members[].value |
string | ||
entry.modifiedAt |
string, or number, or null | ||
entry.operational |
list | ||
entry.operational[] |
string | ||
entry.origin |
string | ||
entry.rule |
string | ||
errors |
list | ||
errors[] |
string | ||
existing |
object | ||
existing.dn |
string | ||
existing.origin |
string | ||
expiresAt |
string, or number, or null | ||
generated |
boolean | ||
invented |
boolean | ||
mailError |
string | ||
mailedTo |
string | ||
message |
string | ||
missing |
list | ||
missing[] |
string | ||
ok |
boolean | yes | |
password |
string | ||
passwordSet |
boolean | ||
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
serviceAccount |
boolean | ||
serviceAccountError |
string | ||
typed |
list | ||
typed[] |
string | ||
unknown |
list | ||
unknown[] |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
activationLink |
string | ||
activationUrl |
string | ||
credential |
string | ||
credentialError |
string | ||
dn |
string | ||
entry |
object | ||
entry.attributes |
map | ||
entry.attributes.{key} |
list, or string | ||
entry.attributes.{key}[] |
string | ||
entry.createdAt |
string, or number, or null | ||
entry.dn |
string | ||
entry.members |
list | ||
entry.members[].attribute |
string | ||
entry.members[].cn |
string | ||
entry.members[].displayName |
string | ||
entry.members[].dn |
string | ||
entry.members[].holds |
string | ||
entry.members[].kind |
string | ||
entry.members[].mail |
string | ||
entry.members[].present |
boolean | ||
entry.members[].userKey |
string | ||
entry.members[].value |
string | ||
entry.modifiedAt |
string, or number, or null | ||
entry.operational |
list | ||
entry.operational[] |
string | ||
entry.origin |
string | ||
entry.rule |
string | ||
errors |
list | ||
errors[] |
string | ||
existing |
object | ||
existing.dn |
string | ||
existing.origin |
string | ||
expiresAt |
string, or number, or null | ||
generated |
boolean | ||
invented |
boolean | ||
mailError |
string | ||
mailedTo |
string | ||
message |
string | ||
missing |
list | ||
missing[] |
string | ||
ok |
boolean | yes | |
password |
string | ||
passwordSet |
boolean | ||
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
serviceAccount |
boolean | ||
serviceAccountError |
string | ||
typed |
list | ||
typed[] |
string | ||
unknown |
list | ||
unknown[] |
string | ||
username |
string |
POST /admin-api/users/create-app-password
createUserAppPassword
Make an app password for somebody, returned once
Generates an APP PASSWORD for the person — twenty-four characters, printed in groups of four — names it, scopes it to one or more of the five password-only doors (ldap, wstrust, scim, ssf, est), stores a scrypt hash of it on their entry and returns it ONCE in appPassword. Nothing can show it again.
What it is for: in product mode a person who holds a second factor, or of whom one is required, is refused their own password at those five doors, which cannot ask for the second factor; an app password scoped to a door is accepted there instead. It is ONE factor, it is accepted ONLY at the doors it names, and NEVER at the sign-in screen or any browser sign-in. A disabled account refuses it; a password reset leaves it alone.
Shared Signals: a CAEP credential-change (password, create) with its name as friendly_name.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
doors |
list | yes | The doors it is accepted at. At least one. |
doors[] |
one of ldap, wstrust, scim, ssf, est, xacml-pep |
||
name |
string | yes | What it is for — the client it goes in. At most 64 characters, unique among this person’s. |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The app password ONCE (appPassword), its public four-character id, name, doors and when it was made.
| Member | Type | Required | What it is |
|---|---|---|---|
appPassword |
string | ||
createdAt |
number | ||
createdBy |
string | ||
doorLabels |
list | ||
doorLabels[] |
string | ||
doors |
list | ||
doors[] |
string | ||
errors |
list | ||
errors[] |
string | ||
id |
string | ||
lastUsedAt |
number | ||
lastUsedDoor |
string | ||
message |
string | ||
name |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
appPassword |
string | ||
createdAt |
number | ||
createdBy |
string | ||
doorLabels |
list | ||
doorLabels[] |
string | ||
doors |
list | ||
doors[] |
string | ||
errors |
list | ||
errors[] |
string | ||
id |
string | ||
lastUsedAt |
number | ||
lastUsedDoor |
string | ||
message |
string | ||
name |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
POST /admin-api/users/deactivate-published-did
deactivateUserPublishedDid
Deactivate a did:web this realm publishes for somebody
Deactivates one of the person’s published DIDs (#1291): its address answers 410 Gone with { id, deactivated: true } for good, a resolver reports deactivated: true, its version history stays resolvable, and it no longer signs the person in, nor is it preferred or released in the did claim. A deactivated DID is never reactivated. An administrator never creates or changes one: that is the person’s act on /portal/self-issued. A DID the person does not hold, or one already deactivated, is refused (STS-VC-0172).
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
did |
string | yes | The DID, or its random id (rid), as GET /admin-api/users/published-dids lists it. |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The DID deactivated.
| Member | Type | Required | What it is |
|---|---|---|---|
deactivated |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
deactivated |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
POST /admin-api/users/delete
deleteUser
Delete somebody’s entry from the directory
Deletes the person’s entry, through the directory’s one person delete: the function SCIM’s DELETE /scim/v2/Users/{id} calls and an LDAP delete reaches. It cannot be undone. The entry goes with everything stored on it (its credentials and passkeys among them) and its profile photo; every group and role that named them lets them go, and every owner list (a service account’s last owner is replaced by the realm’s Admin Write group); RISC receivers are sent account-purged. Everything they held is then ended, as POST /admin-api/users/disable ends it: sessions (with CAEP session-revoked and back-channel Logout Tokens), tokens, codes and connections. Somebody made again under the same name inherits nothing.
Refused for nobody of that name in this realm (STS-LDAP-0013), the realm’s bootstrap administrator (STS-LDAP-0077), an entry with entries beneath it (STS-LDAP-0014), the caller’s own entry (STS-ADMIN-0943), and the last person the realm’s console roster lists for Admin Write or the Security Administrator (STS-ADMIN-0944). A person who holds the Security Administrator’s role is deleted only by a Security Administrator. A person asks for a recent sign-in first, as for a password reset.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: Who was deleted, and the entry’s DN.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
dn |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
dn |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
username |
string |
GET /admin-api/users/devices
getUserDevices
One person’s devices (ou=devices)
Each device entry the person owns: its id and DN, what to call it, the DN of every application that has used it, whether it holds a Native SSO device secret and whether the sign-on session that secret is good for is still live, and when it was made and last used. Never the secret or its hash.
Mirrors GET /admin/users on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
username |
query | string | The older spelling of user, read when user is absent. |
|
user |
query | string | yes | The person, as /admin-api/users names them. |
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 person’s devices.
| Member | Type | Required | What it is |
|---|---|---|---|
devices |
list | ||
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, or number, or null | ||
devices[].complianceChange.compliance |
string | ||
devices[].complianceChange.level |
string | ||
devices[].complianceChange.previous |
string, or null | ||
devices[].complianceChange.reason |
string | ||
devices[].complianceChange.source |
string | ||
devices[].complianceChange.status |
string | ||
devices[].created |
string, or number, or null | ||
devices[].dn |
string | ||
devices[].enrolment |
object | ||
devices[].enrolment.actor |
string | ||
devices[].enrolment.at |
string, or number, or null | ||
devices[].enrolment.method |
string | ||
devices[].id |
string | ||
devices[].keyKinds |
list | ||
devices[].keyKinds[] |
string | ||
devices[].keys |
list | ||
devices[].keys[].added |
string, or number, or null | ||
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, or null | ||
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, or number, or null | ||
devices[].keys[].id |
string | ||
devices[].keys[].kind |
string | ||
devices[].keys[].label |
string | ||
devices[].keys[].material |
any JSON | A device key’s public material as its kind carries it: a client’s JWK, a certificate, or a WebAuthn credential. A device key’s public material as its kind carries it: a client’s JWK, a certificate, or a WebAuthn credential. | |
devices[].keys[].proof |
string | ||
devices[].keys[].thumbprint |
string | ||
devices[].label |
string | ||
devices[].lastUsed |
string, or number, or null | ||
devices[].model |
string | ||
devices[].nativeSso |
boolean | ||
devices[].os |
string | ||
devices[].owner |
string | ||
devices[].ownerKind |
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, or number, or null | ||
devices[].riskChange.compliance |
string | ||
devices[].riskChange.level |
string | ||
devices[].riskChange.previous |
string, or null | ||
devices[].riskChange.reason |
string | ||
devices[].riskChange.source |
string | ||
devices[].riskChange.status |
string | ||
devices[].riskLevel |
string | ||
devices[].sessionLive |
boolean | ||
devices[].status |
string | ||
devices[].statusChange |
object | ||
devices[].statusChange.actor |
string | ||
devices[].statusChange.at |
string, or number, or null | ||
devices[].statusChange.compliance |
string | ||
devices[].statusChange.level |
string | ||
devices[].statusChange.previous |
string, or null | ||
devices[].statusChange.reason |
string | ||
devices[].statusChange.source |
string | ||
devices[].statusChange.status |
string | ||
maxPerPerson |
number | ||
user |
string |
400: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/users/disable
disableUserAccount
Disable somebody’s account, and end everything they hold
Sets pwdAccountLockedTime (draft-behera-ldap-password-policy’s administrative lock, 000001010000Z) on the person’s entry. From then on EVERY door refuses them, in every mode: a password anywhere (the sign-in screen, an LDAP bind, the password grant, WS-Trust, SCIM and SSF Basic, EST), a session from any sign-in (a security key, federation, SPNEGO, a TLS client certificate, the wallet), a Kerberos AS-REQ (KDC_ERR_CLIENT_REVOKED), every token grant made on their behalf (invalid_grant, a refresh token included), every assertion, and this API.
Everything they hold is ended at once, by the same global logout POST /admin-api/logout/global performs: sessions (with CAEP session-revoked and back-channel Logout Tokens to their relying parties), tokens, codes, directory connections and Kerberos tickets. RISC receivers are sent account-disabled. Front-channel notifications need the person’s own browser and are not sent. SCIM’s active: false is the same act.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
reason |
string | Recorded on the audit row. | |
riscReason |
one of hijacking, bulk-account |
RISC account-disabled’s reason (section 2.2), sent to receivers; omitted when not given (#146). |
|
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: Whether anything changed, and in ended what the global logout ended.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
disabled |
boolean | ||
ended |
object | ||
ended.backchannel |
list | ||
ended.backchannel[].attempts |
number | ||
ended.backchannel[].clientId |
string | ||
ended.backchannel[].encrypted |
string | ||
ended.backchannel[].finishedAt |
string | ||
ended.backchannel[].generation |
number | ||
ended.backchannel[].holder |
string | ||
ended.backchannel[].id |
string | ||
ended.backchannel[].inFlight |
boolean | ||
ended.backchannel[].iss |
string | ||
ended.backchannel[].lastAttemptAt |
string | ||
ended.backchannel[].nextAttemptAt |
string | ||
ended.backchannel[].queuedAt |
string | ||
ended.backchannel[].realm |
string | ||
ended.backchannel[].sessionId |
string | ||
ended.backchannel[].sessionRequired |
boolean | ||
ended.backchannel[].sid |
string | ||
ended.backchannel[].state |
string | ||
ended.backchannel[].status |
number, or null | ||
ended.backchannel[].sub |
string | ||
ended.backchannel[].trigger |
string | ||
ended.backchannel[].uri |
string | ||
ended.backchannel[].via |
string | ||
ended.backchannel[].why |
string, or null | ||
ended.ended |
boolean | ||
ended.message |
string | ||
ended.notifications |
number | ||
ended.skipped |
number | ||
ended.terminated |
number | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
disabled |
boolean | ||
ended |
object | ||
ended.backchannel |
list | ||
ended.backchannel[].attempts |
number | ||
ended.backchannel[].clientId |
string | ||
ended.backchannel[].encrypted |
string | ||
ended.backchannel[].finishedAt |
string | ||
ended.backchannel[].generation |
number | ||
ended.backchannel[].holder |
string | ||
ended.backchannel[].id |
string | ||
ended.backchannel[].inFlight |
boolean | ||
ended.backchannel[].iss |
string | ||
ended.backchannel[].lastAttemptAt |
string | ||
ended.backchannel[].nextAttemptAt |
string | ||
ended.backchannel[].queuedAt |
string | ||
ended.backchannel[].realm |
string | ||
ended.backchannel[].sessionId |
string | ||
ended.backchannel[].sessionRequired |
boolean | ||
ended.backchannel[].sid |
string | ||
ended.backchannel[].state |
string | ||
ended.backchannel[].status |
number, or null | ||
ended.backchannel[].sub |
string | ||
ended.backchannel[].trigger |
string | ||
ended.backchannel[].uri |
string | ||
ended.backchannel[].via |
string | ||
ended.backchannel[].why |
string, or null | ||
ended.ended |
boolean | ||
ended.message |
string | ||
ended.notifications |
number | ||
ended.skipped |
number | ||
ended.terminated |
number | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
POST /admin-api/users/disable-mfa
disableUserSecondFactors
Remove every second factor somebody holds
Removes the authenticator app enrolment, every passkey and the recovery codes, in one act. Until #1135 it took only the keys enrolled in the mfa role; a passkey has no role since, and any of them may answer the second step, so it takes all of them. Refused where the passkeys are their way in (STS-AUTHN-0161): a person with no password, in a realm where a passkey may be a first factor, who holds one. Reset their password or issue a reset link first. If a second factor is still REQUIRED of the person — require-mfa, or the realm’s authentication policy — their next sign-in asks them to enrol a new one, which is how to reset somebody’s MFA.
Refused for somebody who holds no second factor.
Shared Signals: a CAEP credential-change (delete) for the authenticator app (app) and for each key (fido2-roaming), and a RISC recovery-information-changed where recovery codes were removed.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
evidence |
string | How the person’s identity was verified, in at least 8 characters. Product mode requires it, and it is recorded in the audit log. | |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: What was removed, and whether a second factor is still required of them (requirement). sessionsEnded counts the sessions each removed factor signed in, which were ended (#963); every other stays.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
failed |
number | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
removed |
object | ||
removed.backupCodes |
boolean | ||
removed.keys |
list | ||
removed.keys[].credentialId |
string | ||
removed.keys[].enrolledAt |
number | ||
removed.keys[].label |
string | ||
removed.totp |
boolean | ||
requirement |
object | ||
requirement.byAdministrator |
boolean | ||
requirement.byRealm |
boolean | ||
requirement.byUser |
boolean | ||
requirement.exemptServiceAccount |
boolean | ||
requirement.offered |
boolean | ||
requirement.required |
boolean | ||
sessionsEnded |
number | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
failed |
number | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
removed |
object | ||
removed.backupCodes |
boolean | ||
removed.keys |
list | ||
removed.keys[].credentialId |
string | ||
removed.keys[].enrolledAt |
number | ||
removed.keys[].label |
string | ||
removed.totp |
boolean | ||
requirement |
object | ||
requirement.byAdministrator |
boolean | ||
requirement.byRealm |
boolean | ||
requirement.byUser |
boolean | ||
requirement.exemptServiceAccount |
boolean | ||
requirement.offered |
boolean | ||
requirement.required |
boolean | ||
sessionsEnded |
number | ||
username |
string |
POST /admin-api/users/disable-primary-keys
disableUserPasskeys
Remove every passkey somebody holds
Removes every passkey (WebAuthn credential) the person holds. Until #1135 it removed only the keys enrolled in the primary role; a passkey has no role since, so it takes all of them, and they sign in with their password afterwards.
Refused where it would leave no way in (STS-AUTHN-0161): a person with no password, in a realm where a passkey may be a first factor, whose passkeys are their way in. Reset their password or issue a reset link first. Refused too for somebody holding no passkey (STS-AUTHN-0160).
Shared Signals: a CAEP credential-change (fido2-roaming, delete) per key, with its label as friendly_name.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
evidence |
string | How the person’s identity was verified, in at least 8 characters. Product mode requires it, and it is recorded in the audit log. | |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The keys removed — id, label and when enrolled; never a public key, and no role since #1135. sessionsEnded counts the sessions those keys signed in, which were ended (#963); every other stays.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
failed |
number | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
removed |
list | ||
removed[].credentialId |
string | ||
removed[].enrolledAt |
number | ||
removed[].label |
string | ||
sessionsEnded |
number | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
failed |
number | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
removed |
list | ||
removed[].credentialId |
string | ||
removed[].enrolledAt |
number | ||
removed[].label |
string | ||
sessionsEnded |
number | ||
username |
string |
POST /admin-api/users/enable
enableUserAccount
Enable a disabled account again
Clears pwdAccountLockedTime. The person signs in afresh — nothing ended by the disable comes back — and RISC receivers are sent account-enabled. SCIM’s active: true is the same act.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
reason |
string | Recorded on the audit row. | |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: Whether anything changed.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
disabled |
boolean | ||
ended |
object | ||
ended.backchannel |
list | ||
ended.backchannel[].attempts |
number | ||
ended.backchannel[].clientId |
string | ||
ended.backchannel[].encrypted |
string | ||
ended.backchannel[].finishedAt |
string | ||
ended.backchannel[].generation |
number | ||
ended.backchannel[].holder |
string | ||
ended.backchannel[].id |
string | ||
ended.backchannel[].inFlight |
boolean | ||
ended.backchannel[].iss |
string | ||
ended.backchannel[].lastAttemptAt |
string | ||
ended.backchannel[].nextAttemptAt |
string | ||
ended.backchannel[].queuedAt |
string | ||
ended.backchannel[].realm |
string | ||
ended.backchannel[].sessionId |
string | ||
ended.backchannel[].sessionRequired |
boolean | ||
ended.backchannel[].sid |
string | ||
ended.backchannel[].state |
string | ||
ended.backchannel[].status |
number, or null | ||
ended.backchannel[].sub |
string | ||
ended.backchannel[].trigger |
string | ||
ended.backchannel[].uri |
string | ||
ended.backchannel[].via |
string | ||
ended.backchannel[].why |
string, or null | ||
ended.ended |
boolean | ||
ended.message |
string | ||
ended.notifications |
number | ||
ended.skipped |
number | ||
ended.terminated |
number | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
disabled |
boolean | ||
ended |
object | ||
ended.backchannel |
list | ||
ended.backchannel[].attempts |
number | ||
ended.backchannel[].clientId |
string | ||
ended.backchannel[].encrypted |
string | ||
ended.backchannel[].finishedAt |
string | ||
ended.backchannel[].generation |
number | ||
ended.backchannel[].holder |
string | ||
ended.backchannel[].id |
string | ||
ended.backchannel[].inFlight |
boolean | ||
ended.backchannel[].iss |
string | ||
ended.backchannel[].lastAttemptAt |
string | ||
ended.backchannel[].nextAttemptAt |
string | ||
ended.backchannel[].queuedAt |
string | ||
ended.backchannel[].realm |
string | ||
ended.backchannel[].sessionId |
string | ||
ended.backchannel[].sessionRequired |
boolean | ||
ended.backchannel[].sid |
string | ||
ended.backchannel[].state |
string | ||
ended.backchannel[].status |
number, or null | ||
ended.backchannel[].sub |
string | ||
ended.backchannel[].trigger |
string | ||
ended.backchannel[].uri |
string | ||
ended.backchannel[].via |
string | ||
ended.backchannel[].why |
string, or null | ||
ended.ended |
boolean | ||
ended.message |
string | ||
ended.notifications |
number | ||
ended.skipped |
number | ||
ended.terminated |
number | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
POST /admin-api/users/enrol-self-issued-subject
enrolUserSelfIssuedSubject
Enrol a self-issued (SIOPv2) subject for somebody
Enrols a did:jwk, did:key or did:web, an RFC 9278 JWK thumbprint URI, a base64url SHA-256 JWK thumbprint or a public JWK (as JSON) on the person’s entry. A self-issued ID Token signed by that key then signs them in, while oid4vp.signInSelfIssued is on. Refused where the subject is already enrolled for anybody in the realm. A person enrols their own on /portal/self-issued by proving the key with their wallet.
What this enrols is recorded as BY VALUE (proof: admin, unproven), and nothing that releases or binds a subject reads it. A did:web’s DID document is fetched now and every authentication key it names is pinned; a later sign-in with any other key is refused (STS-VC-0126). A document that cannot be fetched or names no such key is refused (STS-ADMIN-0871) (#693).
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
label |
string | A name for it, at most 64 characters. | |
subject |
string | yes | The DID, thumbprint or JWK. |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The subject as enrolled.
| Member | Type | Required | What it is |
|---|---|---|---|
enrolled |
object | ||
enrolled.by |
string | ||
enrolled.enrolledAt |
string, or number, or null | ||
enrolled.keyAlg |
string | ||
enrolled.label |
string | ||
enrolled.location |
object | ||
enrolled.location.kind |
string | ||
enrolled.location.value |
string | ||
enrolled.pinnedKeys |
list | ||
enrolled.pinnedKeys[] |
string | ||
enrolled.preferred |
boolean | ||
enrolled.proof |
string | ||
enrolled.provedAt |
string, or number, or null | ||
enrolled.subject |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
enrolled |
object | ||
enrolled.by |
string | ||
enrolled.enrolledAt |
string, or number, or null | ||
enrolled.keyAlg |
string | ||
enrolled.label |
string | ||
enrolled.location |
object | ||
enrolled.location.kind |
string | ||
enrolled.location.value |
string | ||
enrolled.pinnedKeys |
list | ||
enrolled.pinnedKeys[] |
string | ||
enrolled.preferred |
boolean | ||
enrolled.proof |
string | ||
enrolled.provedAt |
string, or number, or null | ||
enrolled.subject |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
POST /admin-api/users/export-ldif
exportUserLdif
Export one person’s entry as an LDIF file
Answers the person’s directory entry as an RFC 2849 LDIF document with one record: ldif (the text) and files (the same, named and base64, which the console saves). The attributes a create takes only — the inetOrgPerson attributes, the credential catalogue’s and the realm’s custom attributes, which is what import-ldif writes back; nothing this service recorded about the person (sign-in methods, federation sightings, consents, flags), no group membership and no entryUUID. The DN is the entry’s own; import-ldif creates the person in whichever realm it is called in.
CREDENTIAL MATERIAL IS LEFT OUT BY DEFAULT and named in leftOut. With credentials true the password’s stored hash, the authenticator app (its secret opened), the passkeys and their user handles, the recovery codes, the app passwords, the stored client certificates, the HOBA keys and the CIBA user code’s hash are written UNENCRYPTED: a value sealed under this process’s key-encryption key is opened, because a file sealed under it opens nowhere else. Keep such a file as you would the secrets in it. Kerberos keys, the RFC 7523 and RFC 7522 key pairs, enrolled certificates and enrolment secrets are never exported: each is minted by its own subsystem. An audit row (user.export) says whether credentials went with the file, never a value. Asked for a recent sign-in, as set-password is.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
credentials |
boolean, or one of true, false, on |
Include credential material, UNENCRYPTED. False when absent. | |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: ldif, files (one .ldif), the attributes written, credentials, and leftOut: the credential attributes not written.
| Member | Type | Required | What it is |
|---|---|---|---|
attributes |
list | ||
attributes[] |
string | ||
changed |
boolean | ||
credentials |
boolean | ||
errors |
list | ||
errors[] |
string | ||
files |
list | ||
files[].base64 |
string | ||
files[].mime |
string | ||
files[].name |
string | ||
files[].text |
string | ||
ldif |
string | ||
leftOut |
list | ||
leftOut[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
attributes |
list | ||
attributes[] |
string | ||
changed |
boolean | ||
credentials |
boolean | ||
errors |
list | ||
errors[] |
string | ||
files |
list | ||
files[].base64 |
string | ||
files[].mime |
string | ||
files[].name |
string | ||
files[].text |
string | ||
ldif |
string | ||
leftOut |
list | ||
leftOut[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
username |
string |
POST /admin-api/users/federation-link
linkUserFederation
Link a federation partner’s subject to a person
Adds a federationLink — <relationship> <issuer> <subject> — to the person’s entry, so that the partner of that service-provider-side relationship signs them in when it asserts that subject. The subject is the partner’s STABLE identifier for them (OpenID Connect sub, a SAML persistent NameID), never a name or an address, and the issuer is the relationship’s fedPeer when omitted. Refused when another person already carries the link (a subject names one person), for a relationship that is not service-provider side, or for a subject that cannot be written. A console administrator is still refused at the sign-in unless the relationship sets fedMayAssertAdministrators. The person’s links are federationLinks (paged by federationLinksPage) on GET /admin-api/users?user=, and a relationship’s are links on GET /admin-api/federation?relationship=. SCIM sets the same values through the urn:ietf:params:scim:schemas:extension:iya-sts:2.0:User extension.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
issuer |
string | The partner’s entity ID or iss; the relationship’s fedPeer when omitted, and refused if it differs from it. |
|
relationship |
string | yes | The service-provider-side relationship the link is through. |
subject |
string | yes | The partner’s identifier for the person. |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The link, whether it was added, and the person’s links now.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
link |
string | ||
links |
list | ||
links[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
link |
string | ||
links |
list | ||
links[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
POST /admin-api/users/federation-unlink
unlinkUserFederation
Remove a federation partner’s link from a person, and end the sessions it made
Removes one federationLink value, named either whole as link (as federationLinks lists it) or as relationship and subject (and issuer). The next sign-in through that relationship no longer finds the person, and every live sign-on session that partner signed them in to is ended — each with its CAEP session-revoked and back-channel Logout Tokens — after the write is answered. Sessions they made any other way are untouched. Removing a link through SCIM or an ldapmodify has the same consequence.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
issuer |
string | Instead of link; the relationship’s fedPeer when omitted. |
|
link |
string | The whole value, as federationLinks[].link shows it. |
|
relationship |
string | Instead of link. |
|
subject |
string | Instead of link. |
|
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The link removed and the person’s links now; the sessions are ended after the answer.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
link |
string | ||
links |
list | ||
links[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
link |
string | ||
links |
list | ||
links[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
POST /admin-api/users/finish-passkey-enrolment
finishUserPasskeyEnrolment
Finish enrolling a passkey for somebody
Verifies what your browser’s navigator.credentials.create() produced EXACTLY as the person’s own registration is verified — the challenge, the origin and RP ID, user verification, the algorithms offered, the exclusion, the attestation statement (#105) and its algorithms (#941), and the passkey policy’s registration rules (#718 and the rest) — and writes the key through the same writer, marked enrolledBy (you, your token’s sub, and when). The enrolment is SPENT by this call whatever it answers: a second finish is refused (STS-AUTHN-0442, STS-AUTHN-0443).
Shared Signals: a CAEP credential-change (fido2-*, create, initiated by admin), and the person is sent the security notice passkey-enrolled. Audited as admin.passkey.enrolled.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
credential |
string | yes | The browser’s registration as JSON: id, rawId, type, authenticatorAttachment, clientExtensionResults and response (clientDataJSON, attestationObject, transports), base64url — or { error, message } where the browser refused. |
enrolmentId |
string | yes | The enrolmentId the begin answered. |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The new passkey’s credentialId, lane (no role since #1135), how many the person now holds (held) and enrolledBy, or why it was not registered.
| Member | Type | Required | What it is |
|---|---|---|---|
credentialId |
string | ||
enrolledBy |
object | ||
enrolledBy.at |
number | ||
enrolledBy.sub |
string | ||
enrolledBy.username |
string | ||
errors |
list | ||
errors[] |
string | ||
held |
number | ||
lane |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
credentialId |
string | ||
enrolledBy |
object | ||
enrolledBy.at |
number | ||
enrolledBy.sub |
string | ||
enrolledBy.username |
string | ||
errors |
list | ||
errors[] |
string | ||
held |
number | ||
lane |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
POST /admin-api/users/finish-passkey-upgrade
finishUserPasskeyUpgrade
Finish upgrading a person’s passkey
Verifies and stores the ML-DSA registration, preserving the existing key if registration fails.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
credential |
string | yes | |
upgradeId |
string | yes | |
user |
string | yes |
200: The upgraded key and both algorithms.
| Member | Type | Required | What it is |
|---|---|---|---|
algorithm |
string | ||
credentialId |
string | ||
errors |
list | ||
errors[] |
string | ||
lane |
string | ||
message |
string | ||
mode |
string | ||
ok |
boolean | yes | |
previousAlgorithm |
string | ||
reason |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
algorithm |
string | ||
credentialId |
string | ||
errors |
list | ||
errors[] |
string | ||
lane |
string | ||
message |
string | ||
mode |
string | ||
ok |
boolean | yes | |
previousAlgorithm |
string | ||
reason |
string |
POST /admin-api/users/import-ldif
importUserLdif
Create a person from an LDIF file
Reads an RFC 2849 LDIF document holding ONE person’s record, as export-ldif writes it (uid=<name>,ou=users,… with that name as its one uid), and creates that person in the realm this is called in, through the create POST /admin-api/users/create makes: the realm’s attribute policy, the username rules and one entry per person are its checks. IT NEVER OVERWRITES: a username already here is refused, naming the entry that holds it (STS-LDAP-0218). A new entryUUID, and so a new subject, is minted; a file carrying one is refused.
Only the attributes a create takes and the credentials an export writes are taken; a record carrying what this service records about a person, or a credential a subsystem mints, is refused naming each (STS-LDAP-0219). A credential in the file is written as stored: a password only as the hash this service writes (a hash cannot be held to the password policy, so a clear password is refused — set one with set-password after the import), the authenticator secret and a legacy recovery-code set sealed again wherever the key-encryption key persists, a passkey user handle or a stored certificate refused when somebody here holds it already (STS-LDAP-0220). No Kerberos key is derived from a hash: the person has none until their password is set again. A CAEP credential-change is sent for each kind of credential that came in, and the import is audited (user.import) with the attribute names, never a value. Give the document as ldif (its text), or as file (its name and text), which is how the console sends an uploaded file. Asked for a recent sign-in, as set-password is.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
file |
object | An uploaded LDIF file: its name and its text. | |
file.name |
string | ||
file.text |
string | yes | |
ldif |
string | The LDIF document. |
200: The username created, its dn, the attributes the create wrote and the credentials written after it.
| Member | Type | Required | What it is |
|---|---|---|---|
attributes |
list | ||
attributes[] |
string | ||
changed |
boolean | ||
credentials |
list | ||
credentials[] |
string | ||
dn |
string | ||
errors |
list | ||
errors[] |
string | ||
kerberosKeys |
boolean | ||
message |
string | ||
ok |
boolean | yes | |
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
attributes |
list | ||
attributes[] |
string | ||
changed |
boolean | ||
credentials |
list | ||
credentials[] |
string | ||
dn |
string | ||
errors |
list | ||
errors[] |
string | ||
kerberosKeys |
boolean | ||
message |
string | ||
ok |
boolean | yes | |
username |
string |
POST /admin-api/users/issue-activation
issueActivationLink
Issue a one-time activation link for a provisioned person
How somebody created through POST /admin-api/users/create, SCIM or an LDAP add comes to have a way in. They are provisioned with no credential; this mints a single-use, time-limited URL at which they choose a password, a security key, or both.
THE URL IS RETURNED ONCE AND NEVER AGAIN. What is stored is a scrypt hash, so this service cannot produce it a second time — only replace it, which is what calling this again does. Treat it as the credential it is: anybody holding it can complete the account setup, so a leaked link is an account takeover.
It expires after security.activationTtlMinutes and is spent the moment the setup FINISHES — not when the link is opened, because a link burned by a mail scanner or a browser prefetch would strand the person it was for.
There is deliberately no self-service version: until the account is activated nobody has proved the address on it is theirs. deliver: "mail" (#63) has this service mail it instead of returning it.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
deliver |
one of show, mail |
mail (#63) sends the link to the address on the person’s entry through the realm’s mail transport and does NOT return it: the answer carries mailedTo. If it cannot be mailed the link is returned as with show (the default), with mailError saying why. |
|
user |
string | yes | The person, as /admin-api/users names them. They must already exist. |
username |
string | Accepted for user. |
200: The activation URL, ONCE, and when it expires — or, with deliver: "mail", the address it was mailed to.
| Member | Type | Required | What it is |
|---|---|---|---|
activationLink |
string | ||
activationUrl |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresAt |
string, or number, or null | ||
mailError |
string | ||
mailedTo |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
activationLink |
string | ||
activationUrl |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresAt |
string, or number, or null | ||
mailError |
string | ||
mailedTo |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
POST /admin-api/users/issue-password-reset
issuePasswordResetLink
Revoke somebody’s password and issue a one-time reset link
Mints a single-use link to /portal/reset-password, returned ONCE in resetUrl (absolute, on the address this request arrived at, realm prefix included), valid for security.passwordResetTtlMinutes. The token in it is stored as a hash; issuing another replaces it.
The password the person had is REMOVED and they are signed out of everything, so until the link is used they cannot sign in with a password. At the link they choose a new one under the realm’s password policy; the removed password is in the history, so it cannot simply be chosen again where the history is enforced.
Shared Signals: a CAEP credential-change (password, revoke) where a password was removed, a RISC account-credential-change-required and recovery-activated (#146), RISC credential-compromise when compromised is true, and a CAEP credential-change (password, create) when the link is spent.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
compromised |
boolean | The reset is BECAUSE a credential was compromised: RISC credential-compromise (password) is sent as well (#146). |
|
deliver |
one of show, mail |
mail (#63) sends the link to the address on the person’s entry through the realm’s mail transport and does NOT return it: the answer carries mailedTo. If it cannot be mailed the link is returned as with show (the default), with mailError saying why. |
|
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The reset link, ONCE, when it expires, whether a password was removed (passwordRevoked) and what the sign-out ended.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
expiresAt |
string, or number, or null | ||
mailError |
string | ||
mailedTo |
string | ||
message |
string | ||
ok |
boolean | yes | |
passwordRevoked |
boolean | ||
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
resetUrl |
string | ||
signedOut |
object | ||
signedOut.ended |
boolean | ||
signedOut.message |
string | ||
signedOut.terminated |
number | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
expiresAt |
string, or number, or null | ||
mailError |
string | ||
mailedTo |
string | ||
message |
string | ||
ok |
boolean | yes | |
passwordRevoked |
boolean | ||
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
resetUrl |
string | ||
signedOut |
object | ||
signedOut.ended |
boolean | ||
signedOut.message |
string | ||
signedOut.terminated |
number | ||
username |
string |
POST /admin-api/users/issue-signing-certificate
issueUserSigningCertificate
Issue somebody a message-signing certificate from this realm’s CA
Generates a key pair and certifies it from the realm’s message-signing Issuing CA with digitalSignature only and urn:sts:person:<username> as its subjectAltName (urn:sts:sa:<username> for a service account, #1827). A WS-Trust request whose WS-Security signature over the SOAP Body and Timestamp verifies under it authenticates the person as its requester; it signs nobody in over TLS. An administrator’s act: the person has no door to it on the user portal (#521).
THIS REPLY IS THE ONLY COPY OF THE PRIVATE KEY. files holds a PKCS#12 (base64), an encrypted PKCS#8 PEM key and the PEM chain, all protected by password, which is neither stored nor audited. Refused past pki.messageSigningCertificateMax valid certificates (STS-PKI-0220), for a person with no entry (STS-ADMIN-0905), for a key algorithm outside rsa-2048, rsa-3072, ec-p256, ec-p384, and in a realm with no certificate authority.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
confirm |
string | ||
days |
integer | ||
keyAlg |
one of rsa-2048, rsa-3072, ec-p256, ec-p384 |
||
label |
string | ||
password |
string | yes | |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The certificate (serial, subject, thumbprint, PEM and chain, its urn:sts: name), the three files, and the person’s message-signing certificates as they now stand, in signing.
| Member | Type | Required | What it is |
|---|---|---|---|
certificate |
object | ||
certificate.certificatePem |
string | ||
certificate.chainPem |
list | ||
certificate.chainPem[] |
string | ||
certificate.implicitName |
string | ||
certificate.keyAlg |
string | ||
certificate.label |
string | ||
certificate.notAfter |
string, or number, or null | ||
certificate.notBefore |
string, or number, or null | ||
certificate.serialHex |
string | ||
certificate.subject |
string | ||
certificate.thumbprint |
string | ||
errors |
list | ||
errors[] |
string | ||
files |
object | ||
files.chain |
object | ||
files.chain.base64 |
string | ||
files.chain.mime |
string | ||
files.chain.name |
string | ||
files.chain.text |
string | ||
files.key |
object | ||
files.key.base64 |
string | ||
files.key.mime |
string | ||
files.key.name |
string | ||
files.key.text |
string | ||
files.pkcs12 |
object | ||
files.pkcs12.base64 |
string | ||
files.pkcs12.mime |
string | ||
files.pkcs12.name |
string | ||
files.pkcs12.text |
string | ||
message |
string | ||
ok |
boolean | yes | |
purpose |
string | ||
signing |
object | ||
signing.active |
number | ||
signing.caAvailable |
boolean | ||
signing.certificates |
list | ||
signing.certificates[].certificatePem |
string | ||
signing.certificates[].keyAlg |
string | ||
signing.certificates[].label |
string | ||
signing.certificates[].notAfter |
string, or number, or null | ||
signing.certificates[].notBefore |
string, or number, or null | ||
signing.certificates[].reason |
string, or null | ||
signing.certificates[].revokedAt |
string, or number, or null | ||
signing.certificates[].serialHex |
string | ||
signing.certificates[].state |
string | ||
signing.certificates[].subject |
string | ||
signing.certificates[].thumbprint |
string | ||
signing.defaultKeyAlg |
string | ||
signing.holder |
string | ||
signing.implicitName |
string | ||
signing.keyAlgorithms |
list | ||
signing.keyAlgorithms[] |
string | ||
signing.kind |
string | ||
signing.max |
number | ||
signing.ok |
boolean | ||
signing.passwordMin |
number | ||
signing.revocationReasons |
list | ||
signing.revocationReasons[] |
string | ||
user |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
certificate |
object | ||
certificate.certificatePem |
string | ||
certificate.chainPem |
list | ||
certificate.chainPem[] |
string | ||
certificate.implicitName |
string | ||
certificate.keyAlg |
string | ||
certificate.label |
string | ||
certificate.notAfter |
string, or number, or null | ||
certificate.notBefore |
string, or number, or null | ||
certificate.serialHex |
string | ||
certificate.subject |
string | ||
certificate.thumbprint |
string | ||
errors |
list | ||
errors[] |
string | ||
files |
object | ||
files.chain |
object | ||
files.chain.base64 |
string | ||
files.chain.mime |
string | ||
files.chain.name |
string | ||
files.chain.text |
string | ||
files.key |
object | ||
files.key.base64 |
string | ||
files.key.mime |
string | ||
files.key.name |
string | ||
files.key.text |
string | ||
files.pkcs12 |
object | ||
files.pkcs12.base64 |
string | ||
files.pkcs12.mime |
string | ||
files.pkcs12.name |
string | ||
files.pkcs12.text |
string | ||
message |
string | ||
ok |
boolean | yes | |
purpose |
string | ||
signing |
object | ||
signing.active |
number | ||
signing.caAvailable |
boolean | ||
signing.certificates |
list | ||
signing.certificates[].certificatePem |
string | ||
signing.certificates[].keyAlg |
string | ||
signing.certificates[].label |
string | ||
signing.certificates[].notAfter |
string, or number, or null | ||
signing.certificates[].notBefore |
string, or number, or null | ||
signing.certificates[].reason |
string, or null | ||
signing.certificates[].revokedAt |
string, or number, or null | ||
signing.certificates[].serialHex |
string | ||
signing.certificates[].state |
string | ||
signing.certificates[].subject |
string | ||
signing.certificates[].thumbprint |
string | ||
signing.defaultKeyAlg |
string | ||
signing.holder |
string | ||
signing.implicitName |
string | ||
signing.keyAlgorithms |
list | ||
signing.keyAlgorithms[] |
string | ||
signing.kind |
string | ||
signing.max |
number | ||
signing.ok |
boolean | ||
signing.passwordMin |
number | ||
signing.revocationReasons |
list | ||
signing.revocationReasons[] |
string | ||
user |
string |
POST /admin-api/users/issue-tls-client-certificate
issueUserTlsClientCertificate
Issue somebody a TLS client certificate from this realm’s CA
Generates a key pair and certifies it from the realm’s tls-client Issuing CA with clientAuth. The subject is the person’s directory name — common name and UID first, then the entry’s own naming attributes, then the organisation and country — and urn:sts:person:<username> (urn:sts:sa:<username> for a service account, #1827) is its subjectAltName, which is what admits a remote PEP that presents the certificate. It is not stored on the entry as userCertificate.
THIS REPLY IS THE ONLY COPY OF THE PRIVATE KEY. files holds a PKCS#12 (base64), an encrypted PKCS#8 PEM key and the PEM chain, all protected by password, which is neither stored nor audited. Refused past the maximum of valid TLS client certificates for a person, for a person with no entry (STS-ADMIN-0939), for a file password that is too short or does not match (STS-ADMIN-0940), for a key algorithm outside rsa-2048, rsa-3072, ec-p256, ec-p384, and in a realm with no certificate authority.
Mirrors POST /admin/users on the admin console (Credentials, Key pairs).
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 |
|---|---|---|---|
confirm |
string | ||
days |
integer | ||
keyAlg |
one of rsa-2048, rsa-3072, ec-p256, ec-p384 |
||
label |
string | ||
password |
string | yes | |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The certificate (serial, subject, thumbprint, PEM and chain, its urn:sts: name), the three files, and the person’s TLS client certificates as they now stand, in tls.
| Member | Type | Required | What it is |
|---|---|---|---|
certificate |
object | ||
certificate.certificatePem |
string | ||
certificate.chainPem |
list | ||
certificate.chainPem[] |
string | ||
certificate.implicitName |
string | ||
certificate.keyAlg |
string | ||
certificate.label |
string | ||
certificate.notAfter |
string, or number, or null | ||
certificate.notBefore |
string, or number, or null | ||
certificate.serialHex |
string | ||
certificate.subject |
string | ||
certificate.thumbprint |
string | ||
errors |
list | ||
errors[] |
string | ||
files |
object | ||
files.chain |
object | ||
files.chain.base64 |
string | ||
files.chain.mime |
string | ||
files.chain.name |
string | ||
files.chain.text |
string | ||
files.key |
object | ||
files.key.base64 |
string | ||
files.key.mime |
string | ||
files.key.name |
string | ||
files.key.text |
string | ||
files.pkcs12 |
object | ||
files.pkcs12.base64 |
string | ||
files.pkcs12.mime |
string | ||
files.pkcs12.name |
string | ||
files.pkcs12.text |
string | ||
message |
string | ||
ok |
boolean | yes | |
tls |
object | ||
tls.active |
number | ||
tls.caAvailable |
boolean | ||
tls.certificates |
list | ||
tls.certificates[].certificatePem |
string | ||
tls.certificates[].keyAlg |
string | ||
tls.certificates[].label |
string | ||
tls.certificates[].notAfter |
string, or number, or null | ||
tls.certificates[].notBefore |
string, or number, or null | ||
tls.certificates[].reason |
string, or null | ||
tls.certificates[].revokedAt |
string, or number, or null | ||
tls.certificates[].serialHex |
string | ||
tls.certificates[].state |
string | ||
tls.certificates[].subject |
string | ||
tls.certificates[].thumbprint |
string | ||
tls.defaultKeyAlg |
string | ||
tls.entryDn |
string | ||
tls.holder |
string | ||
tls.implicitName |
string | ||
tls.keyAlgorithms |
list | ||
tls.keyAlgorithms[] |
string | ||
tls.kind |
string | ||
tls.max |
number | ||
tls.ok |
boolean | ||
tls.passwordMin |
number | ||
tls.revocationReasons |
list | ||
tls.revocationReasons[] |
string | ||
tls.subjectDn |
string | ||
user |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
certificate |
object | ||
certificate.certificatePem |
string | ||
certificate.chainPem |
list | ||
certificate.chainPem[] |
string | ||
certificate.implicitName |
string | ||
certificate.keyAlg |
string | ||
certificate.label |
string | ||
certificate.notAfter |
string, or number, or null | ||
certificate.notBefore |
string, or number, or null | ||
certificate.serialHex |
string | ||
certificate.subject |
string | ||
certificate.thumbprint |
string | ||
errors |
list | ||
errors[] |
string | ||
files |
object | ||
files.chain |
object | ||
files.chain.base64 |
string | ||
files.chain.mime |
string | ||
files.chain.name |
string | ||
files.chain.text |
string | ||
files.key |
object | ||
files.key.base64 |
string | ||
files.key.mime |
string | ||
files.key.name |
string | ||
files.key.text |
string | ||
files.pkcs12 |
object | ||
files.pkcs12.base64 |
string | ||
files.pkcs12.mime |
string | ||
files.pkcs12.name |
string | ||
files.pkcs12.text |
string | ||
message |
string | ||
ok |
boolean | yes | |
tls |
object | ||
tls.active |
number | ||
tls.caAvailable |
boolean | ||
tls.certificates |
list | ||
tls.certificates[].certificatePem |
string | ||
tls.certificates[].keyAlg |
string | ||
tls.certificates[].label |
string | ||
tls.certificates[].notAfter |
string, or number, or null | ||
tls.certificates[].notBefore |
string, or number, or null | ||
tls.certificates[].reason |
string, or null | ||
tls.certificates[].revokedAt |
string, or number, or null | ||
tls.certificates[].serialHex |
string | ||
tls.certificates[].state |
string | ||
tls.certificates[].subject |
string | ||
tls.certificates[].thumbprint |
string | ||
tls.defaultKeyAlg |
string | ||
tls.entryDn |
string | ||
tls.holder |
string | ||
tls.implicitName |
string | ||
tls.keyAlgorithms |
list | ||
tls.keyAlgorithms[] |
string | ||
tls.kind |
string | ||
tls.max |
number | ||
tls.ok |
boolean | ||
tls.passwordMin |
number | ||
tls.revocationReasons |
list | ||
tls.revocationReasons[] |
string | ||
tls.subjectDn |
string | ||
user |
string |
GET /admin-api/users/new
getNewUserForm
Every attribute a person may be created with, and the four ways they can be given a way in
The ATTRIBUTE CATALOGUE a create takes in attributes — one row per attribute a person in this directory may carry, each naming the claim it reaches in an issued token or credential and the document its name comes from — plus the container DN the entry would land in, the realm, and the four credential options.
It creates nobody: the create is POST /admin-api/users/create. This is the list that call validates against, and an attribute name that is not on it is REFUSED rather than dropped — so a caller that reads this first cannot be told afterwards that half of what it sent was ignored.
uid and userPassword are deliberately not on it. uid is the username, sent as username, and a second way to set it would allow an entry at uid=alice whose uid attribute says bob. A password goes through credential, so that credentials.js hashes it — an attribute door that took userPassword would write one in the clear.
The container is THIS REALM’S. The embedded directory is per trust realm, so /realm/acme/admin-api/users/new answers with acme’s ou=users and a person created there is invisible to every other realm.
Mirrors GET /admin/users/new on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
user |
query | string | A username to open the form for, which the form starts from when the request gives no body. | |
invent |
query | string | A username: the answer carries invented, the attribute values this service would invent for that person, which the console’s Fill button puts into every box nobody has typed in. In development mode only — elsewhere invented is null and inventRefused says why. It creates nobody. |
|
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 attribute catalogue, the credential options, the container and the realm.
| Member | Type | Required | What it is |
|---|---|---|---|
container |
string, or null | ||
credential |
string | ||
credentials |
list | ||
credentials[].id |
string | ||
credentials[].label |
string | ||
credentials[].what |
string | ||
defaultCredential |
string | ||
directory |
boolean | ||
fieldGroups |
list | ||
fieldGroups[].attributes |
list | ||
fieldGroups[].attributes[] |
string | ||
fieldGroups[].id |
string | ||
fieldGroups[].label |
string | ||
fieldGroups[].what |
string | ||
fieldRows |
list | ||
fieldRows[].attribute |
string | ||
fieldRows[].claim |
list | ||
fieldRows[].claim[] |
string | ||
fieldRows[].custom |
boolean | ||
fieldRows[].everyFamily |
boolean | ||
fieldRows[].example |
string | ||
fieldRows[].families |
list | ||
fieldRows[].families[] |
string | ||
fieldRows[].forText |
string | ||
fieldRows[].group |
string | ||
fieldRows[].label |
string | ||
fieldRows[].multi |
boolean | ||
fieldRows[].required |
boolean | ||
fieldRows[].schema |
string | ||
fieldRows[].simple |
boolean | ||
fieldRows[].takes |
string | ||
fieldRows[].type |
string | ||
fieldRows[].what |
string | ||
fields |
list | ||
fields[].attribute |
string | ||
fields[].claim |
list | ||
fields[].claim[] |
string | ||
fields[].invented |
boolean | ||
fields[].label |
string | ||
fields[].schema |
string | ||
gridFields |
list | ||
gridFields[].attribute |
string | ||
gridFields[].custom |
boolean | ||
gridFields[].example |
string | ||
gridFields[].group |
string | ||
gridFields[].label |
string | ||
gridFields[].multi |
boolean | ||
gridFields[].simple |
boolean | ||
gridFields[].takes |
string | ||
inventRefused |
string | ||
invented |
map | ||
invented.{key} |
list, or string | ||
invented.{key}[] |
string | ||
longTextAttributes |
list | ||
longTextAttributes[] |
string | ||
mailAvailable |
boolean | ||
mode |
string | ||
offersExampleData |
boolean | ||
passwordPolicy |
object | ||
passwordPolicy.enforced |
boolean | ||
passwordPolicy.profile |
string | ||
passwordPolicy.rules |
list | ||
passwordPolicy.rules[] |
string | ||
persistence |
object | ||
persistence.mode |
string | ||
persistence.persistsDirectory |
boolean | ||
realm |
object | ||
realm.id |
string | ||
realm.name |
string | ||
requiredAttributes |
list | ||
requiredAttributes[] |
string | ||
requiredEnforced |
boolean | ||
username |
string | ||
why |
string |
400: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/users/prove-passkey-upgrade
proveUserPasskeyUpgrade
Prove possession of a person’s classical passkey
Verifies the assertion before offering the ML-DSA registration ceremony. A refused proof leaves the existing key unchanged.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
credential |
string | yes | |
upgradeId |
string | yes | |
user |
string | yes |
200: The ML-DSA registration ceremony.
| Member | Type | Required | What it is |
|---|---|---|---|
ceremony |
object | ||
ceremony.challenge |
string | ||
ceremony.exclude |
list | ||
ceremony.exclude[] |
string | ||
ceremony.options |
object | ||
ceremony.options.algorithms |
list | ||
ceremony.options.algorithms[] |
number | ||
ceremony.options.attestation |
string | ||
ceremony.options.authenticatorSelection |
object | ||
ceremony.options.authenticatorSelection.authenticatorAttachment |
string | ||
ceremony.options.authenticatorSelection.requireResidentKey |
boolean | ||
ceremony.options.authenticatorSelection.residentKey |
string | ||
ceremony.options.authenticatorSelection.userVerification |
string | ||
ceremony.options.credProps |
boolean | ||
ceremony.options.hints |
list | ||
ceremony.options.hints[] |
string | ||
ceremony.options.minPinLength |
boolean | ||
ceremony.options.rp |
object | ||
ceremony.options.rp.id |
string | ||
ceremony.options.rp.name |
string | ||
ceremony.options.timeout |
number | ||
ceremony.rpId |
string | ||
ceremony.user |
object | ||
ceremony.user.displayName |
string | ||
ceremony.user.id |
string | ||
ceremony.user.name |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
reason |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
ceremony |
object | ||
ceremony.challenge |
string | ||
ceremony.exclude |
list | ||
ceremony.exclude[] |
string | ||
ceremony.options |
object | ||
ceremony.options.algorithms |
list | ||
ceremony.options.algorithms[] |
number | ||
ceremony.options.attestation |
string | ||
ceremony.options.authenticatorSelection |
object | ||
ceremony.options.authenticatorSelection.authenticatorAttachment |
string | ||
ceremony.options.authenticatorSelection.requireResidentKey |
boolean | ||
ceremony.options.authenticatorSelection.residentKey |
string | ||
ceremony.options.authenticatorSelection.userVerification |
string | ||
ceremony.options.credProps |
boolean | ||
ceremony.options.hints |
list | ||
ceremony.options.hints[] |
string | ||
ceremony.options.minPinLength |
boolean | ||
ceremony.options.rp |
object | ||
ceremony.options.rp.id |
string | ||
ceremony.options.rp.name |
string | ||
ceremony.options.timeout |
number | ||
ceremony.rpId |
string | ||
ceremony.user |
object | ||
ceremony.user.displayName |
string | ||
ceremony.user.id |
string | ||
ceremony.user.name |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
reason |
string |
GET /admin-api/users/published-dids
getUserPublishedDids
The did:web DIDs this realm publishes for one person
Each did:web this realm publishes for the person (#1291): its random id (rid), the DID, where its document is (documentUrl), who holds its key (custody: wallet, realm or download), its state (active, deactivated, or suspended while the account is disabled), the provenance of its self-issued subject (proof), whether it is the preferred DID, its currentVersion, any change waiting for its new key (pending), and every version with its keys (ids and algorithms, never a private key) and what authorized it. Beside them, whether the realm publishes DIDs now (did.personPublishing), its custody and how many active ones a person may hold. An administrator may deactivate one (deactivate-published-did) and never create or change one.
Mirrors GET /admin/users on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
username |
query | string | The older spelling of user, read when user is absent. |
|
user |
query | string | yes | The person, as /admin-api/users names them. |
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 published DIDs.
| Member | Type | Required | What it is |
|---|---|---|---|
custody |
string | ||
dids |
list | ||
dids[].by |
string | ||
dids[].createdAt |
string, or number, or null | ||
dids[].currentVersion |
string, or number | ||
dids[].custody |
string | ||
dids[].deactivated |
object, or boolean, or string, or null | ||
dids[].deactivated.at |
string, or number, or null | ||
dids[].deactivated.by |
string | ||
dids[].deactivated.reason |
string | ||
dids[].deactivated.via |
string | ||
dids[].did |
string | ||
dids[].documentUrl |
string | ||
dids[].pending |
object | ||
dids[].pending.change |
string | ||
dids[].pending.expiresAt |
string, or number, or null | ||
dids[].preferred |
boolean | ||
dids[].proof |
string | ||
dids[].rid |
string | ||
dids[].state |
string | ||
dids[].versions |
list | ||
dids[].versions[].authorizedBy |
list | ||
dids[].versions[].authorizedBy[].actor |
string | ||
dids[].versions[].authorizedBy[].at |
string, or number, or null | ||
dids[].versions[].authorizedBy[].keyThumbprint |
string | ||
dids[].versions[].authorizedBy[].kind |
string | ||
dids[].versions[].authorizedBy[].subject |
string | ||
dids[].versions[].authorizedBy[].transaction |
string | ||
dids[].versions[].authorizedBy[].versionId |
string, or number | ||
dids[].versions[].change |
string | ||
dids[].versions[].created |
string, or number, or null | ||
dids[].versions[].keys |
list | ||
dids[].versions[].keys[].alg |
string | ||
dids[].versions[].keys[].crv |
string | ||
dids[].versions[].keys[].id |
string | ||
dids[].versions[].keys[].kty |
string | ||
dids[].versions[].versionId |
string, or number | ||
entryFound |
boolean | ||
maxPerPerson |
number | ||
publishing |
boolean | ||
user |
string |
400: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/users/record-verification
recordUserVerification
Record an identity verification for somebody
Keeps an OpenID Connect for Identity Assurance 1.0 verification element on the person’s entry, with the claims it covered. trust_framework must be one of oauth2.idaTrustFrameworks; each evidence element is checked by its type (document, electronic_record, vouch, electronic_signature) against the vocabularies discovery publishes; time defaults to now. Each claim’s value is taken from the entry as it is now, and a claim the entry holds nothing for is refused. The console’s form posts the same thing as flat fields.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
claims |
list | yes | The claims it covered, from claims_in_verified_claims_supported. |
claims[] |
one of name, given_name, family_name, middle_name, birthdate, gender, address, email, phone_number, place_of_birth, nationalities, birth_family_name, birth_given_name, birth_middle_name, salutation, title, msisdn, also_known_as |
||
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
|
verification |
object | yes | The verification element (Identity Assurance section 5.1). |
200: The verification as recorded.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string | ||
verification |
object | ||
verification.by |
string | ||
verification.claims |
any JSON | The verified claims and their values, as the OpenID Connect claim each is: a string for most, an object for address, a list for nationalities. The verified claims and their values, as the OpenID Connect claim each is: a string for most, an object for address, a list for nationalities. |
|
verification.id |
string | ||
verification.recorded |
string, or number, or null | ||
verification.source |
string | ||
verification.verification |
any JSON | The OpenID Connect for Identity Assurance verification element: a caller may post it whole as JSON, and a wallet or a certificate may supply it, so its evidence is that specification’s to shape. The OpenID Connect for Identity Assurance verification element: a caller may post it whole as JSON, and a wallet or a certificate may supply it, so its evidence is that specification’s to shape. |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string | ||
verification |
object | ||
verification.by |
string | ||
verification.claims |
any JSON | The verified claims and their values, as the OpenID Connect claim each is: a string for most, an object for address, a list for nationalities. The verified claims and their values, as the OpenID Connect claim each is: a string for most, an object for address, a list for nationalities. |
|
verification.id |
string | ||
verification.recorded |
string, or number, or null | ||
verification.source |
string | ||
verification.verification |
any JSON | The OpenID Connect for Identity Assurance verification element: a caller may post it whole as JSON, and a wallet or a certificate may supply it, so its evidence is that specification’s to shape. The OpenID Connect for Identity Assurance verification element: a caller may post it whole as JSON, and a wallet or a certificate may supply it, so its evidence is that specification’s to shape. |
POST /admin-api/users/remove-attribute
removeUserAttributeValue
Remove one value from one of somebody’s attributes
One attribute of the person’s directory entry, written in place, as an ldapmodify of it would be. The attributes it takes are the person schema (person, organizationalPerson, inetOrgPerson and the Identity Assurance claims) and the credential catalogue, less what is managed: userPassword (set-password), the binary ones, uid, mail (set-mail, which verifies it) and whichever attribute names the entry. attributeEditor in GET /admin-api/users?user= lists them, with what each holds and the shape its value must have. A change is told to Shared Signals as a SCIM or LDAP write of it is.
remove takes off the value named, compared without regard to case; it is refused for a value not held and for the last value of cn or sn.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
attribute |
string | yes | The attribute, as attributeEditor.attributes[].name in GET /admin-api/users?user= names it. |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
|
value |
string | yes | The value to remove. |
200: The attribute and every value it now holds.
| Member | Type | Required | What it is |
|---|---|---|---|
attribute |
string | ||
dn |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
mode |
string | ||
ok |
boolean | yes | |
reason |
string | ||
values |
list | ||
values[] |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
attribute |
string | ||
dn |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
mode |
string | ||
ok |
boolean | yes | |
reason |
string | ||
values |
list | ||
values[] |
string |
POST /admin-api/users/remove-certificate
removeUserCertificate
Take a stored certificate off somebody’s entry
Removes one certificate from the person’s userCertificate, named by the SHA-256 of its DER (as GET /admin-api/users/certificates lists it). From then on it signs nobody in (#1061).
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
sha256 |
string | yes | The SHA-256 of the certificate’s DER, hex. |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The certificates the entry stores now.
| Member | Type | Required | What it is |
|---|---|---|---|
certificates |
list | ||
certificates[].expired |
boolean | ||
certificates[].issuer |
string | ||
certificates[].notAfter |
string | ||
certificates[].notBefore |
string | ||
certificates[].readable |
boolean | ||
certificates[].serialNumber |
string | ||
certificates[].sha256 |
string | ||
certificates[].subject |
string | ||
changed |
boolean | ||
dn |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
rule |
string | ||
sha256 |
string | ||
user |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
certificates |
list | ||
certificates[].expired |
boolean | ||
certificates[].issuer |
string | ||
certificates[].notAfter |
string | ||
certificates[].notBefore |
string | ||
certificates[].readable |
boolean | ||
certificates[].serialNumber |
string | ||
certificates[].sha256 |
string | ||
certificates[].subject |
string | ||
changed |
boolean | ||
dn |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
rule |
string | ||
sha256 |
string | ||
user |
string |
POST /admin-api/users/remove-device
removeUserDevice
Remove one of somebody’s devices
Deletes the device entry from ou=devices, and its Native SSO device secret with it: the apps on the device can no longer share a sign-in, and sign in again. The tokens already issued stand until the sign-on session they belong to ends.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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’s id, from GET /admin-api/users/devices. |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: What was removed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
removed |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
removed |
string | ||
username |
string |
POST /admin-api/users/remove-self-issued-subject
removeUserSelfIssuedSubject
Remove one of somebody’s self-issued subjects
Takes the subject off the person’s entry; its self-issued ID Token signs nobody in afterwards.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
subject |
string | yes | The subject, as listed. |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: What was removed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
removed |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
removed |
string | ||
username |
string |
POST /admin-api/users/remove-service-account-owner
removeServiceAccountOwner
Take one owner off a service account
Takes one owner off the service account and writes at once, keeping the rest and the push destination (#602). owner is the DN the account lists. Refused for one it does not list; for the last owner, whatever the service-account policy says (STS-SVCACCT-0061); and for the caller themselves — their own DN, or the group that is their only way of owning the account (STS-SVCACCT-0062, STS-SVCACCT-0063). Another administrator may remove them.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
owner |
string | yes | The owner’s DN. |
user |
string | yes | The service account, as /admin-api/users names it. |
username |
string | Accepted for user. |
200: The account as it now stands.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
object | ||
account.destination |
string | ||
account.dn |
string | ||
account.ownerProtected |
boolean | ||
account.owners |
list | ||
account.owners[].dn |
string | ||
account.owners[].kind |
string | ||
account.owners[].name |
string | ||
account.owners[].present |
boolean | ||
account.policy |
string | ||
account.previousPasswordExpires |
number | ||
account.rotatedAt |
string | ||
account.rotation |
object | ||
account.rotation.failures |
number | ||
account.rotation.lastAttempt |
number | ||
account.rotation.lastError |
string | ||
account.secretName |
string | ||
account.serviceAccount |
boolean | ||
account.username |
string | ||
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
object | ||
account.destination |
string | ||
account.dn |
string | ||
account.ownerProtected |
boolean | ||
account.owners |
list | ||
account.owners[].dn |
string | ||
account.owners[].kind |
string | ||
account.owners[].name |
string | ||
account.owners[].present |
boolean | ||
account.policy |
string | ||
account.previousPasswordExpires |
number | ||
account.rotatedAt |
string | ||
account.rotation |
object | ||
account.rotation.failures |
number | ||
account.rotation.lastAttempt |
number | ||
account.rotation.lastError |
string | ||
account.secretName |
string | ||
account.serviceAccount |
boolean | ||
account.username |
string | ||
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
POST /admin-api/users/remove-verification
removeUserVerification
Remove one of somebody’s identity verifications
Takes the verification with this id off the person’s entry; nothing is released from it afterwards.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 verification’s id, from GET /admin-api/users/verifications. |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: What was removed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
removed |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
removed |
string | ||
username |
string |
POST /admin-api/users/rename-key
renameUserPasskey
Rename one of somebody’s passkeys
Goes through the same renameKey() the person’s own portal calls (POST /portal/rename-key): a name is at most 60 characters with no control characters, and an EMPTY name restores the default — the provider FIDO MDS names for the key’s AAGUID where a BLOB is loaded, else the credential manager’s, else “Passkey” or “Security key”. The credential id is the base64url one on this person’s factors.keys. Audited; no Shared Signals event, because a name says nothing about what the key proves.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
credentialId |
string | yes | base64url, as WebAuthn produced it. |
label |
string | The new name; empty restores the default. | |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The name the passkey now has, or why it was not renamed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
label |
string | ||
message |
string | ||
ok |
boolean | yes |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
label |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/users/require-mfa
requireUserSecondFactor
Require somebody to sign in with a second factor
Sets stsMfaRequired on the person’s entry. At the sign-in screen they are then asked for a second factor — and, while they hold none, shown a step to enrol an authenticator app or a passkey before any session is started. A passwordless passkey sign-in is refused while it is required.
In product mode it also refuses their own password at the five password-only doors — an LDAP bind, a WS-Trust UsernameToken, SCIM, SSF and EST Basic — answered as a wrong password; an app password (create-app-password) is what they use there (#101). In product the KDC refuses their password alone too (KDC_ERR_POLICY, #173); a ticket takes an authenticator code through FAST and OTP, or a certificate through PKINIT (#179). What it does not reach is a sign-in that is neither that screen nor one of those doors: federation, a TLS client certificate. The authentication policy’s requireSecondFactor: always is the same requirement for every person in the realm.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The requirement as it now stands, by account and by realm.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
required |
boolean | ||
requirement |
object | ||
requirement.byAdministrator |
boolean | ||
requirement.byRealm |
boolean | ||
requirement.byUser |
boolean | ||
requirement.exemptServiceAccount |
boolean | ||
requirement.offered |
boolean | ||
requirement.required |
boolean | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
required |
boolean | ||
requirement |
object | ||
requirement.byAdministrator |
boolean | ||
requirement.byRealm |
boolean | ||
requirement.byUser |
boolean | ||
requirement.exemptServiceAccount |
boolean | ||
requirement.offered |
boolean | ||
requirement.required |
boolean | ||
username |
string |
POST /admin-api/users/reset-password
resetUserPassword
Reset somebody’s password to a generated one, returned once
Generates a password under this realm’s password policy, sets it, and returns it ONCE in password — the entry holds a scrypt hash and nothing can show it again. Then three things the ordinary set-password does not do: pwdReset is set, so the person must choose their own password at the sign-in screen before anything is signed in; any password reset link outstanding is spent; and they are signed out of everything through the same function POST /admin-api/logout/global calls.
Shared Signals: a CAEP credential-change (password, update) and a RISC account-credential-change-required, plus a CAEP session-revoked for each session the sign-out ends. They are sent after the reply, and caep.autoEmitTypes and risc.autoEmitTypes decide whether they go at all.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
compromised |
boolean | The reset is BECAUSE a credential was compromised: RISC credential-compromise (password) is sent as well (#146). |
|
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The generated password, ONCE, whether the forced change was recorded (forcedChange) and what the sign-out ended (signedOut).
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
forcedChange |
boolean | ||
message |
string | ||
ok |
boolean | yes | |
password |
string | ||
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
signedOut |
object | ||
signedOut.ended |
boolean | ||
signedOut.message |
string | ||
signedOut.terminated |
number | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
forcedChange |
boolean | ||
message |
string | ||
ok |
boolean | yes | |
password |
string | ||
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
signedOut |
object | ||
signedOut.ended |
boolean | ||
signedOut.message |
string | ||
signedOut.terminated |
number | ||
username |
string |
POST /admin-api/users/revoke-app-password
revokeUserAppPassword
Revoke one of somebody’s app passwords
Removes the app password with this id — the four characters GET /admin-api/users/app-passwords lists — from the person’s entry. A client still sending it is refused at its next authentication.
Shared Signals: a CAEP credential-change (password, revoke) with its name as friendly_name.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 app password’s public id. |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: What was revoked — its id, name and doors; never its hash.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
revoked |
object | ||
revoked.createdAt |
number | ||
revoked.createdBy |
string | ||
revoked.doorLabels |
list | ||
revoked.doorLabels[] |
string | ||
revoked.doors |
list | ||
revoked.doors[] |
string | ||
revoked.id |
string | ||
revoked.lastUsedAt |
number | ||
revoked.lastUsedDoor |
string | ||
revoked.name |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
revoked |
object | ||
revoked.createdAt |
number | ||
revoked.createdBy |
string | ||
revoked.doorLabels |
list | ||
revoked.doorLabels[] |
string | ||
revoked.doors |
list | ||
revoked.doors[] |
string | ||
revoked.id |
string | ||
revoked.lastUsedAt |
number | ||
revoked.lastUsedDoor |
string | ||
revoked.name |
string | ||
username |
string |
POST /admin-api/users/revoke-signing-certificate
revokeUserSigningCertificate
Revoke one of somebody’s message-signing certificates
Revokes a certificate issue-signing-certificate issued to THIS person — a serial belonging to anybody else, or one of their TLS client certificates, matches nothing (STS-PKI-0221) — onto the Issuing CA’s CRL and OCSP responder. A WS-Trust request signed with it is refused from then on. The person’s certificates are listed in mfa.signing of GET /admin-api/users?user= (#521).
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
reason |
one of cessationOfOperation, keyCompromise |
||
serialHex |
string | yes | |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The revoked certificate, the reason, and the person’s message-signing certificates as they now stand.
| Member | Type | Required | What it is |
|---|---|---|---|
already |
boolean | ||
certificate |
object | ||
certificate.certificatePem |
string | ||
certificate.createdAt |
string, or number, or null | ||
certificate.keyAlg |
string | ||
certificate.label |
string | ||
certificate.notAfter |
string, or number, or null | ||
certificate.notBefore |
string, or number, or null | ||
certificate.reason |
string, or null | ||
certificate.revokedAt |
string, or number, or null | ||
certificate.serialHex |
string | ||
certificate.slot |
string | ||
certificate.state |
string | ||
certificate.subject |
string | ||
certificate.thumbprint |
string | ||
entry |
object | ||
entry.note |
string | ||
entry.reason |
string | ||
entry.reasonCode |
number | ||
entry.reasonWhat |
string | ||
entry.revokedAt |
string, or number, or null | ||
entry.serialHex |
string | ||
entry.subject |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
reason |
string | ||
signing |
object | ||
signing.active |
number | ||
signing.caAvailable |
boolean | ||
signing.certificates |
list | ||
signing.certificates[].certificatePem |
string | ||
signing.certificates[].keyAlg |
string | ||
signing.certificates[].label |
string | ||
signing.certificates[].notAfter |
string, or number, or null | ||
signing.certificates[].notBefore |
string, or number, or null | ||
signing.certificates[].reason |
string, or null | ||
signing.certificates[].revokedAt |
string, or number, or null | ||
signing.certificates[].serialHex |
string | ||
signing.certificates[].state |
string | ||
signing.certificates[].subject |
string | ||
signing.certificates[].thumbprint |
string | ||
signing.defaultKeyAlg |
string | ||
signing.holder |
string | ||
signing.implicitName |
string | ||
signing.keyAlgorithms |
list | ||
signing.keyAlgorithms[] |
string | ||
signing.kind |
string | ||
signing.max |
number | ||
signing.ok |
boolean | ||
signing.passwordMin |
number | ||
signing.revocationReasons |
list | ||
signing.revocationReasons[] |
string | ||
user |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
already |
boolean | ||
certificate |
object | ||
certificate.certificatePem |
string | ||
certificate.createdAt |
string, or number, or null | ||
certificate.keyAlg |
string | ||
certificate.label |
string | ||
certificate.notAfter |
string, or number, or null | ||
certificate.notBefore |
string, or number, or null | ||
certificate.reason |
string, or null | ||
certificate.revokedAt |
string, or number, or null | ||
certificate.serialHex |
string | ||
certificate.slot |
string | ||
certificate.state |
string | ||
certificate.subject |
string | ||
certificate.thumbprint |
string | ||
entry |
object | ||
entry.note |
string | ||
entry.reason |
string | ||
entry.reasonCode |
number | ||
entry.reasonWhat |
string | ||
entry.revokedAt |
string, or number, or null | ||
entry.serialHex |
string | ||
entry.subject |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
reason |
string | ||
signing |
object | ||
signing.active |
number | ||
signing.caAvailable |
boolean | ||
signing.certificates |
list | ||
signing.certificates[].certificatePem |
string | ||
signing.certificates[].keyAlg |
string | ||
signing.certificates[].label |
string | ||
signing.certificates[].notAfter |
string, or number, or null | ||
signing.certificates[].notBefore |
string, or number, or null | ||
signing.certificates[].reason |
string, or null | ||
signing.certificates[].revokedAt |
string, or number, or null | ||
signing.certificates[].serialHex |
string | ||
signing.certificates[].state |
string | ||
signing.certificates[].subject |
string | ||
signing.certificates[].thumbprint |
string | ||
signing.defaultKeyAlg |
string | ||
signing.holder |
string | ||
signing.implicitName |
string | ||
signing.keyAlgorithms |
list | ||
signing.keyAlgorithms[] |
string | ||
signing.kind |
string | ||
signing.max |
number | ||
signing.ok |
boolean | ||
signing.passwordMin |
number | ||
signing.revocationReasons |
list | ||
signing.revocationReasons[] |
string | ||
user |
string | ||
why |
string |
POST /admin-api/users/revoke-tls-client-certificate
revokeUserTlsClientCertificate
Revoke one of somebody’s TLS client certificates
Revokes a certificate issue-tls-client-certificate issued to THIS person — a serial belonging to anybody else, or one of their message-signing certificates, matches nothing — onto the Issuing CA’s CRL and OCSP responder. A handshake that presents it is refused from then on. The person’s certificates are listed in mfa.tls of GET /admin-api/users?user=.
Mirrors POST /admin/users on the admin console (Credentials, Key pairs).
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 |
|---|---|---|---|
reason |
one of cessationOfOperation, keyCompromise |
||
serialHex |
string | yes | |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The revoked certificate, the reason, and the person’s TLS client certificates as they now stand.
| Member | Type | Required | What it is |
|---|---|---|---|
already |
boolean | ||
certificate |
object | ||
certificate.certificatePem |
string | ||
certificate.createdAt |
string, or number, or null | ||
certificate.keyAlg |
string | ||
certificate.label |
string | ||
certificate.notAfter |
string, or number, or null | ||
certificate.notBefore |
string, or number, or null | ||
certificate.reason |
string, or null | ||
certificate.revokedAt |
string, or number, or null | ||
certificate.serialHex |
string | ||
certificate.slot |
string | ||
certificate.state |
string | ||
certificate.subject |
string | ||
certificate.thumbprint |
string | ||
entry |
object | ||
entry.note |
string | ||
entry.reason |
string | ||
entry.reasonCode |
number | ||
entry.reasonWhat |
string | ||
entry.revokedAt |
string, or number, or null | ||
entry.serialHex |
string | ||
entry.subject |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
reason |
string | ||
tls |
object | ||
tls.active |
number | ||
tls.caAvailable |
boolean | ||
tls.certificates |
list | ||
tls.certificates[].certificatePem |
string | ||
tls.certificates[].keyAlg |
string | ||
tls.certificates[].label |
string | ||
tls.certificates[].notAfter |
string, or number, or null | ||
tls.certificates[].notBefore |
string, or number, or null | ||
tls.certificates[].reason |
string, or null | ||
tls.certificates[].revokedAt |
string, or number, or null | ||
tls.certificates[].serialHex |
string | ||
tls.certificates[].state |
string | ||
tls.certificates[].subject |
string | ||
tls.certificates[].thumbprint |
string | ||
tls.defaultKeyAlg |
string | ||
tls.entryDn |
string | ||
tls.holder |
string | ||
tls.implicitName |
string | ||
tls.keyAlgorithms |
list | ||
tls.keyAlgorithms[] |
string | ||
tls.kind |
string | ||
tls.max |
number | ||
tls.ok |
boolean | ||
tls.passwordMin |
number | ||
tls.revocationReasons |
list | ||
tls.revocationReasons[] |
string | ||
tls.subjectDn |
string | ||
user |
string | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
already |
boolean | ||
certificate |
object | ||
certificate.certificatePem |
string | ||
certificate.createdAt |
string, or number, or null | ||
certificate.keyAlg |
string | ||
certificate.label |
string | ||
certificate.notAfter |
string, or number, or null | ||
certificate.notBefore |
string, or number, or null | ||
certificate.reason |
string, or null | ||
certificate.revokedAt |
string, or number, or null | ||
certificate.serialHex |
string | ||
certificate.slot |
string | ||
certificate.state |
string | ||
certificate.subject |
string | ||
certificate.thumbprint |
string | ||
entry |
object | ||
entry.note |
string | ||
entry.reason |
string | ||
entry.reasonCode |
number | ||
entry.reasonWhat |
string | ||
entry.revokedAt |
string, or number, or null | ||
entry.serialHex |
string | ||
entry.subject |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
reason |
string | ||
tls |
object | ||
tls.active |
number | ||
tls.caAvailable |
boolean | ||
tls.certificates |
list | ||
tls.certificates[].certificatePem |
string | ||
tls.certificates[].keyAlg |
string | ||
tls.certificates[].label |
string | ||
tls.certificates[].notAfter |
string, or number, or null | ||
tls.certificates[].notBefore |
string, or number, or null | ||
tls.certificates[].reason |
string, or null | ||
tls.certificates[].revokedAt |
string, or number, or null | ||
tls.certificates[].serialHex |
string | ||
tls.certificates[].state |
string | ||
tls.certificates[].subject |
string | ||
tls.certificates[].thumbprint |
string | ||
tls.defaultKeyAlg |
string | ||
tls.entryDn |
string | ||
tls.holder |
string | ||
tls.implicitName |
string | ||
tls.keyAlgorithms |
list | ||
tls.keyAlgorithms[] |
string | ||
tls.kind |
string | ||
tls.max |
number | ||
tls.ok |
boolean | ||
tls.passwordMin |
number | ||
tls.revocationReasons |
list | ||
tls.revocationReasons[] |
string | ||
tls.subjectDn |
string | ||
user |
string | ||
why |
string |
POST /admin-api/users/rotate-password
rotateServiceAccountPassword
Rotate a service account’s password now
QUEUES a rotation of the service account’s password on the scheduler’s leader (the job service-accounts.rotate-now, #221): a password drawn by the password policy’s generator at the service-account policy’s length is PUSHED to the account’s destination first and committed here only once the push succeeded; the previous password is accepted for the policy’s overlap. A failed push changes nothing. The answer is the run’s id — GET /admin-api/scheduler shows its outcome — and never a password: the destination is where it is read.
Refused for an entry that is not a service account, or one that names no destination. A rotating account’s password cannot be set by hand (set-password, reset-password): this is the way.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
user |
string | yes | The service account, as /admin-api/users names it. |
username |
string | Accepted for user. |
200: The queued run (runId, alreadyQueued).
| Member | Type | Required | What it is |
|---|---|---|---|
alreadyQueued |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
runId |
string, or number | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
alreadyQueued |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
runId |
string, or number | ||
username |
string |
GET /admin-api/users/self-issued-subjects
getUserSelfIssuedSubjects
The self-issued (SIOPv2) subjects enrolled for one person
Each DID or RFC 9278 JWK thumbprint URI enrolled for the person, with its label, when and by whom — every one a key whose self-issued ID Token signs them in — and how (proof: wallet, proved by the person, or admin, enrolled by value), with a did:web’s pinnedKeys and the one proved DID the person prefers (preferred) (#693), and where the key came from (location, { kind, value }: web and the web wallet’s configured address, app and the name the wallet app reported in its User-Agent or ‘’, dc_api and the browser origin or ‘’, admin; absent on an enrolment from before it was recorded). Beside them, whether signing in that way is on (oid4vp.signInSelfIssued), how many a person may hold, and the subject syntaxes accepted.
Mirrors GET /admin/users on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
username |
query | string | The older spelling of user, read when user is absent. |
|
user |
query | string | yes | The person, as /admin-api/users names them. |
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 subjects enrolled.
| Member | Type | Required | What it is |
|---|---|---|---|
entryFound |
boolean | ||
maxPerPerson |
number | ||
signInEnabled |
boolean | ||
subjectSyntaxTypes |
list | ||
subjectSyntaxTypes[] |
string | ||
subjects |
list | ||
subjects[].by |
string | ||
subjects[].enrolledAt |
string, or number, or null | ||
subjects[].keyAlg |
string | ||
subjects[].label |
string | ||
subjects[].location |
object | ||
subjects[].location.kind |
string | ||
subjects[].location.value |
string | ||
subjects[].pinnedKeys |
list | ||
subjects[].pinnedKeys[] |
string | ||
subjects[].preferred |
boolean | ||
subjects[].proof |
string | ||
subjects[].provedAt |
string, or number, or null | ||
subjects[].subject |
string | ||
user |
string |
400: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/users/set-attribute
setUserAttribute
Replace every value of one of somebody’s attributes
One attribute of the person’s directory entry, written in place, as an ldapmodify of it would be. The attributes it takes are the person schema (person, organizationalPerson, inetOrgPerson and the Identity Assurance claims) and the credential catalogue, less what is managed: userPassword (set-password), the binary ones, uid, mail (set-mail, which verifies it) and whichever attribute names the entry. attributeEditor in GET /admin-api/users?user= lists them, with what each holds and the shape its value must have. A change is told to Shared Signals as a SCIM or LDAP write of it is.
set REPLACES every value with value; an empty value removes the attribute, except cn and sn, which every person must hold.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
attribute |
string | yes | The attribute, as attributeEditor.attributes[].name in GET /admin-api/users?user= names it. |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
|
value |
string | The one value it will hold; empty removes it. |
200: The attribute and every value it now holds.
| Member | Type | Required | What it is |
|---|---|---|---|
attribute |
string | ||
dn |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
mode |
string | ||
ok |
boolean | yes | |
reason |
string | ||
values |
list | ||
values[] |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
attribute |
string | ||
dn |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
mode |
string | ||
ok |
boolean | yes | |
reason |
string | ||
values |
list | ||
values[] |
string |
POST /admin-api/users/set-aud-sub
setUserAudSub
Record the account id a client knows somebody by
OpenID Connect Enterprise Extensions section 2.3 (#148): the ID Tokens issued for this person to this client carry it as aud_sub. An empty value removes it. Audited.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
client |
string | yes | The client_id. |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
|
value |
string | The aud_sub; empty removes it. |
200: What the ID Token now carries.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/users/set-delegation-semantics
setUserDelegationSemantics
Set the delegation semantics a person allows
Writes stsDelegationSemantics (the semantics the person allows: delegation, impersonation, or both; empty leaves it to the issuance policy, which reads an empty set as both for a subject and delegation only for an actor) and stsDefaultDelegationSemantics (what an act they are part of is when the request does not say). Read by the exchange policy at an RFC 8693 token exchange, a WS-Trust OnBehalfOf / ActAs and a Kerberos S4U request (#186).
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
default |
one of delegation, impersonation |
The default; left out, it is cleared. | |
semantics |
list, or string | ||
semantics[] |
one of delegation, impersonation |
||
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The semantics as they now stand.
| Member | Type | Required | What it is |
|---|---|---|---|
defaultSemantics |
string, or null | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
semantics |
list | ||
semantics[] |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
defaultSemantics |
string, or null | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
semantics |
list | ||
semantics[] |
string | ||
username |
string |
POST /admin-api/users/set-mail
setUserMail
Set somebody’s email address
Writes mail on the person’s entry and marks it VERIFIED (stsMailVerified): an administrator is one of the trusted sources #64 names, with SCIM, an administrator’s LDAP write and a federation partner. The FORMER address, if there was one, is told it changed. Refused unless it is an address this service could send to.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
mail |
string | yes | The address. |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The address now on the entry, verified.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
mail |
string | ||
message |
string | ||
ok |
boolean | yes | |
verified |
boolean |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
mail |
string | ||
message |
string | ||
ok |
boolean | yes | |
verified |
boolean |
POST /admin-api/users/set-may-act
setUserMayAct
Name the one party who may act for somebody
Sets or clears stsMayAct on the person’s entry: the DN of a person or an application in this realm. Access tokens issued about the person then carry RFC 8693 section 4.4’s may_act naming that party (a person by their urn:uuid: subject, an application by its client_id), and a token exchange of such a token by anybody else is refused invalid_request in every mode. The person sets the same thing themselves on /portal/delegate.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
delegate |
string | The DN of the person or application; empty clears it. | |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The delegate as it now stands.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
mayAct |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
mayAct |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
POST /admin-api/users/set-not-delegated
setUserNotDelegated
Mark somebody as one who cannot be delegated
Sets (value true, the default) or clears stsNotDelegated on the person’s entry — Kerberos’s NOT_DELEGATED, “sensitive and cannot be delegated”. While it is set nobody may act for them at WS-Trust OnBehalfOf / ActAs or the RFC 8693 token exchange, whatever any application’s delegation attributes say. Enforced in product mode; development records what would have been refused on /admin/delegation. Members of the console’s Admin Read and Admin Write rosters are protected the same way without it.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
|
value |
boolean | true sets the flag (the default), false clears it. |
200: The flag as it now stands.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
notDelegated |
boolean | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
notDelegated |
boolean | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
POST /admin-api/users/set-password
setUserPassword
Set or replace somebody’s password
Hashed with scrypt by credentials.js, which is the one place in this service a password is ever verified or set, and written to userPassword on their directory entry. It cannot be read back by anything — not this API, not the console, not an ldapsearch, which sees the hash — so a lost password is replaced rather than recovered.
Send password, or generate: true to have one made up and RETURNED ONCE. The person must already exist; this creates nobody.
IN DEVELOPMENT MODE THIS CHANGES ALMOST NOTHING AND IS STILL WORTH DOING. Nothing here checks a password in development — every one is accepted — so setting one does not make a sign-in work that would otherwise fail. What it does is put the attribute on the entry, which is what an LDAP client reads, what hasPassword() counts, and what product mode would need. In PRODUCT mode it is the credential.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
generate |
boolean | Make one up instead — 32 bytes of randomBytes, base64url, the same generator the product-mode bootstrap account uses. It is RETURNED ONCE in password and never again. |
|
password |
string | The password to set. Required unless generate is true. |
|
passwordConfirm |
string | Optional, checked where sent. | |
user |
string | yes | The person, as /admin-api/users names them. They must already exist. |
username |
string | Accepted for user. |
200: Whether it was set, and — only where it was GENERATED — the password, once. A password you sent is never echoed back: you already hold it, and returning it would put it in a second place.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
generated |
boolean | ||
message |
string | ||
ok |
boolean | yes | |
password |
string | ||
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
generated |
boolean | ||
message |
string | ||
ok |
boolean | yes | |
password |
string | ||
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
POST /admin-api/users/set-preferred-self-issued-subject
setUserPreferredSelfIssuedSubject
Mark one of somebody’s proved DIDs as their preferred one, or clear the mark
Marks the subject — a DID the person PROVED with their wallet (proof: wallet) — as their preferred DID, and clears the mark from every other; an empty subject clears it. The preferred DID is what the did claim releases to a client allowed the did scope that the person consented to, where oauth2.didClaim is on (#693). A subject enrolled by value, a JWK thumbprint or one not enrolled is refused (STS-ADMIN-0872). The person does the same on /portal/self-issued.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
subject |
string | The DID, as listed; empty or absent clears the mark. | |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The preferred DID, or none.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
preferred |
string, or null | ||
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
preferred |
string, or null | ||
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
POST /admin-api/users/set-pseudonyms
setUserPseudonyms
Add or remove one of somebody’s sign-in names
A name the person can sign in with, in place of their username (#644). An email is stored live unless it is already somebody else’s address; any other name is live at once. cancelPending drops a name that is still waiting for its link. Exactly one of add, remove and cancelPending. Audited as admin.pseudonym.set. The name is not repeated on that row.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
add |
string | A name to add. | |
cancelPending |
boolean, or string | True cancels a name waiting for its link. | |
remove |
string | A live name to remove. | |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The live names, and a pending address when one is still waiting.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
pending |
map, or string, or boolean, or null | ||
pending.{key} |
string, or number, or boolean, or null | ||
pseudonyms |
list | ||
pseudonyms[] |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
pending |
map, or string, or boolean, or null | ||
pending.{key} |
string, or number, or boolean, or null | ||
pseudonyms |
list | ||
pseudonyms[] |
string |
POST /admin-api/users/set-service-account
setUserServiceAccount
Make somebody a service account, or change one
A service account is a PERSON entry carrying stsServiceAccount (#221): everything a person is — a password, app passwords, Kerberos keys, groups, roles, Shared Signals under their iss_sub — and governed by the realm’s service-account policy (GET /admin-api/policies, kind serviceAccount): whether the second factor is exempt, whether a browser sign-in is allowed (not by default), which password doors open, and whether its password rotates and is pushed to a secrets manager.
serviceAccount true (the default) sets or changes it: owners, the WHOLE list of the people and groups in this realm who answer for it (#600) — it replaces the list the account names, at most 25, at least one while the policy’s requireOwner is on; destination, a push destination’s DN, and secretName go together. A service account is never made an ordinary person again (rcbj, 2026-11-15): serviceAccount false on one is REFUSED (STS-SVCACCT-0060), and on an ordinary person changes nothing; deleting the entry is the only way to end an account. Once an account names an owner its owners may not become empty, whatever requireOwner says (STS-SVCACCT-0061), and the caller may not take themselves off — their own DN, or the group that was their only way of owning it (STS-SVCACCT-0062, STS-SVCACCT-0063).
Where the policy refuses a service account every browser sign-in, becoming one ENDS the person’s sessions (signedOut). SCIM does not carry the flag; an LDAP modify by a holder of Admin Write may, under the same rules.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
destination |
string | The DN of the push destination (an application entry). | |
owners |
list | The people and groups answerable for the account (#600), each a DN, a username or a group’s cn: an array, or a string of one per line. It REPLACES the owners the account names; absent or empty is none, refused while the policy requires an owner, and always refused on a service account that names an owner now. | |
owners[] |
string | ||
secretName |
string | The secret’s name or path at the destination; it must already exist there. | |
serviceAccount |
boolean | true makes or keeps them a service account (the default). false is refused on a service account, which is never made a person again, and changes nothing on an ordinary person. | |
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The account as it now stands (account), and the sessions ended (signedOut).
| Member | Type | Required | What it is |
|---|---|---|---|
account |
object | ||
account.destination |
string | ||
account.dn |
string | ||
account.ownerProtected |
boolean | ||
account.owners |
list | ||
account.owners[].dn |
string | ||
account.owners[].kind |
string | ||
account.owners[].name |
string | ||
account.owners[].present |
boolean | ||
account.policy |
string | ||
account.previousPasswordExpires |
number | ||
account.rotatedAt |
string | ||
account.rotation |
object | ||
account.rotation.failures |
number | ||
account.rotation.lastAttempt |
number | ||
account.rotation.lastError |
string | ||
account.secretName |
string | ||
account.serviceAccount |
boolean | ||
account.username |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
serviceAccount |
boolean | ||
signedOut |
object | ||
signedOut.ended |
boolean | ||
signedOut.message |
string | ||
signedOut.terminated |
number | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
object | ||
account.destination |
string | ||
account.dn |
string | ||
account.ownerProtected |
boolean | ||
account.owners |
list | ||
account.owners[].dn |
string | ||
account.owners[].kind |
string | ||
account.owners[].name |
string | ||
account.owners[].present |
boolean | ||
account.policy |
string | ||
account.previousPasswordExpires |
number | ||
account.rotatedAt |
string | ||
account.rotation |
object | ||
account.rotation.failures |
number | ||
account.rotation.lastAttempt |
number | ||
account.rotation.lastError |
string | ||
account.secretName |
string | ||
account.serviceAccount |
boolean | ||
account.username |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
serviceAccount |
boolean | ||
signedOut |
object | ||
signedOut.ended |
boolean | ||
signedOut.message |
string | ||
signedOut.terminated |
number | ||
username |
string |
POST /admin-api/users/set-service-account-destination
setServiceAccountDestination
Set or clear a service account’s push destination
Sets where the service account’s rotated password is pushed (#602) and writes at once, keeping the owners: destination, the DN of a secret destination of this realm (GET /admin-api/secret-destinations), and secretName, the secret’s name or path there, which must already exist. Both or neither: both empty clears them.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
destination |
string | The destination’s DN, or empty. | |
secretName |
string | The secret’s name or path there, or empty. | |
user |
string | yes | The service account, as /admin-api/users names it. |
username |
string | Accepted for user. |
200: The account as it now stands.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
object | ||
account.destination |
string | ||
account.dn |
string | ||
account.ownerProtected |
boolean | ||
account.owners |
list | ||
account.owners[].dn |
string | ||
account.owners[].kind |
string | ||
account.owners[].name |
string | ||
account.owners[].present |
boolean | ||
account.policy |
string | ||
account.previousPasswordExpires |
number | ||
account.rotatedAt |
string | ||
account.rotation |
object | ||
account.rotation.failures |
number | ||
account.rotation.lastAttempt |
number | ||
account.rotation.lastError |
string | ||
account.secretName |
string | ||
account.serviceAccount |
boolean | ||
account.username |
string | ||
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
object | ||
account.destination |
string | ||
account.dn |
string | ||
account.ownerProtected |
boolean | ||
account.owners |
list | ||
account.owners[].dn |
string | ||
account.owners[].kind |
string | ||
account.owners[].name |
string | ||
account.owners[].present |
boolean | ||
account.policy |
string | ||
account.previousPasswordExpires |
number | ||
account.rotatedAt |
string | ||
account.rotation |
object | ||
account.rotation.failures |
number | ||
account.rotation.lastAttempt |
number | ||
account.rotation.lastError |
string | ||
account.secretName |
string | ||
account.serviceAccount |
boolean | ||
account.username |
string | ||
changed |
boolean | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
username |
string |
POST /admin-api/users/stop-requiring-mfa
stopRequiringUserSecondFactor
Take the per-account second-factor requirement off
Clears stsMfaRequired. A realm requirement (the authentication policy) is unaffected and the reply says whether one is in force. A second factor the person holds goes on being asked for, as it always is.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account on the admin console.
Scope: admin:write.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires. |
|
cell |
query | string | The cell to answer this request, where this service runs as several. Ignored in a service that runs as one. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The requirement as it now stands.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
required |
boolean | ||
requirement |
object | ||
requirement.byAdministrator |
boolean | ||
requirement.byRealm |
boolean | ||
requirement.byUser |
boolean | ||
requirement.exemptServiceAccount |
boolean | ||
requirement.offered |
boolean | ||
requirement.required |
boolean | ||
username |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
problems |
list | ||
problems[] |
map, or string | ||
problems[].{key} |
string, or number, or boolean, or null | ||
reason |
string | ||
required |
boolean | ||
requirement |
object | ||
requirement.byAdministrator |
boolean | ||
requirement.byRealm |
boolean | ||
requirement.byUser |
boolean | ||
requirement.exemptServiceAccount |
boolean | ||
requirement.offered |
boolean | ||
requirement.required |
boolean | ||
username |
string |
POST /admin-api/users/update-fields
updateUserFields
Set several of somebody’s attributes at once
What the Save button of a tab of a person’s Attributes on the console does. Each member of fields names an attribute attributeEditor in GET /admin-api/users?user= lists as editable, and gives what it should hold: a single-valued attribute is SET (an empty string or array clears it), and a multi-valued one has the values put in added and then the values taken out removed — exactly set-attribute, add-attribute and remove-attribute, applied per attribute, so every rule those hold still holds, and each change is audited and told to Shared Signals as one of those is. An attribute whose values did not change is not written.
What one attribute refuses does not undo another: the reply names what was saved (changed) and every refusal, and answers 400 when there was any.
Mirrors POST /admin/users, POST /admin/users/new, POST /admin/users/edit and POST /admin/users/service-account 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 |
|---|---|---|---|
fields |
object | Attribute name to a string or an array of strings; empty clears it. | |
present |
list | The fields the console’s form drew, by attribute name, space or comma separated or as a list: each one is cleared when the form carries no value for it. | |
present[] |
string | ||
user |
string | yes | The person, as /admin-api/users names them. |
username |
string | Accepted for user. |
200: The attributes saved (changed).
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
list | ||
changed[] |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
user |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
changed |
list | ||
changed[] |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
user |
string |
GET /admin-api/users/verifications
getUserVerifications
One person’s identity verifications (OpenID Connect for Identity Assurance)
Each verification recorded for the person, newest first: its id, where it came from (source: admin, wallet or certificate), when and by whom, the verification element — trust framework, time, evidence — and the claims it covered with the values that were verified. A client’s verified_claims request is answered from these, for a claim only while the entry still holds the verified value. Beside them, the vocabularies a record is made from.
Mirrors GET /admin/users on the admin console.
Scope: admin:read.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
username |
query | string | The older spelling of user, read when user is absent. |
|
user |
query | string | yes | The person, as /admin-api/users names them. |
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 verifications and its paging.
| Member | Type | Required | What it is |
|---|---|---|---|
attestationTypes |
list | ||
attestationTypes[] |
string | ||
checkMethods |
list | ||
checkMethods[] |
string | ||
documentTypes |
list | ||
documentTypes[] |
string | ||
electronicRecordTypes |
list | ||
electronicRecordTypes[] |
string | ||
evidenceTypes |
list | ||
evidenceTypes[] |
string | ||
page |
integer | ||
pages |
integer | ||
paging |
object | ||
paging.firstRow |
integer | ||
paging.lastRow |
integer | ||
paging.noun |
string | ||
paging.page |
integer | ||
paging.pages |
integer | ||
paging.param |
string | ||
paging.perPage |
integer | ||
paging.total |
integer | ||
perPage |
integer | ||
total |
integer | ||
trustFrameworks |
list | ||
trustFrameworks[] |
string | ||
user |
string | ||
verifiableClaims |
list | ||
verifiableClaims[] |
string | ||
verifications |
list | ||
verifications[].by |
string | ||
verifications[].claims |
any JSON | The verified claims and their values, as the OpenID Connect claim each is: a string for most, an object for address, a list for nationalities. The verified claims and their values, as the OpenID Connect claim each is: a string for most, an object for address, a list for nationalities. |
|
verifications[].id |
string | ||
verifications[].recorded |
string, or number, or null | ||
verifications[].source |
string | ||
verifications[].verification |
any JSON | The OpenID Connect for Identity Assurance verification element: a caller may post it whole as JSON, and a wallet or a certificate may supply it, so its evidence is that specification’s to shape. The OpenID Connect for Identity Assurance verification element: a caller may post it whole as JSON, and a wallet or a certificate may supply it, so its evidence is that specification’s to shape. |
400: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |