This is the documentation of iya-sts 1.0.0. The latest is 1.1.0.
What a person can see and do about their own account. How it is used.
The user portal’s API: everything a person can see and do about their own account in this trust realm. The person is ALWAYS the access token’s subject — no operation takes a username, an id or a DN naming whose account it is. A token is obtained by the authorization code flow with PKCE (S256) as the public client sts-user-portal, with resource set to this API, and is DPoP-bound (RFC 9449): send it as Authorization: DPoP <token> with a DPoP proof carrying ath. It stops working when the sign-on session it was issued on ends. The few operations marked x-access: link take no token: they spend the single-use secret of an activation or reset link they carry.
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 | ||
ok |
boolean |
GET /account-api
getIndex
Lists every operation of this API
Each operation’s method, path, access and the portal page or form it is the door of. The portal reads it to know which operation a form goes to.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
api |
string | ||
document |
string | ||
operations |
list | ||
operations[].access |
string | ||
operations[].method |
string | ||
operations[].mirrors |
string, or null | ||
operations[].operationId |
string | ||
operations[].path |
string | ||
operations[].query |
list | ||
operations[].query[] |
string | ||
operations[].summary |
string | ||
operations[].tag |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/access-requests
getAccessRequests
The AuthZEN access requests waiting for you to decide
The pending access requests (#1180) whose denying policy named you an approver — its approver role, its approver group, or the application’s owners — and that the access-control policy lets you decide: each with who it is about, what it asks to do to what, through which PEP and application, and until when it waits. enabled is false where the realm has the profile off.
The door of the portal’s GET /portal/access-requests.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
enabled |
boolean | ||
rows |
list | ||
rows[].action |
any JSON | An AuthZEN Authorization API 1.0 member as the PEP sent it: its properties and its context are the caller’s to define. An AuthZEN Authorization API 1.0 member as the PEP sent it: its properties and its context are the caller’s to define. |
|
rows[].application |
string, or null | ||
rows[].approval |
object | ||
rows[].approval.approvedAt |
string or number, or null | ||
rows[].approval.approvedUntil |
string or number, or null | ||
rows[].approval.approver |
string, or null | ||
rows[].approval.id |
string | ||
rows[].approval.revoked |
boolean | ||
rows[].approvers |
object | ||
rows[].approvers.groups |
list | ||
rows[].approvers.groups[] |
string | ||
rows[].approvers.owners |
boolean | ||
rows[].approvers.roles |
list | ||
rows[].approvers.roles[] |
string | ||
rows[].client |
object | ||
rows[].client.id |
string | ||
rows[].client.name |
string | ||
rows[].context |
any JSON | An AuthZEN Authorization API 1.0 member as the PEP sent it: its properties and its context are the caller’s to define. An AuthZEN Authorization API 1.0 member as the PEP sent it: its properties and its context are the caller’s to define. |
|
rows[].createdAt |
string or number, or null | ||
rows[].decidedBy |
string | ||
rows[].emergency |
boolean | ||
rows[].expiresAt |
string or number, or null | ||
rows[].finishedAt |
string or number, or null | ||
rows[].id |
string | ||
rows[].justification |
string | ||
rows[].requester |
string, or null | ||
rows[].resource |
any JSON | An AuthZEN Authorization API 1.0 member as the PEP sent it: its properties and its context are the caller’s to define. An AuthZEN Authorization API 1.0 member as the PEP sent it: its properties and its context are the caller’s to define. |
|
rows[].status |
string | ||
rows[].subject |
any JSON | An AuthZEN Authorization API 1.0 member as the PEP sent it: its properties and its context are the caller’s to define. An AuthZEN Authorization API 1.0 member as the PEP sent it: its properties and its context are the caller’s to define. |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/access-requests
decideAccessRequest
Approves or denies an AuthZEN access request
Decides one request as you, after the access-control policy (action approve-access-request on resource authzen-access-request) said you may: an approval is handed to the PEP to carry on its next evaluation, which the realm’s policy decides afresh; a denial ends the request. Refused for a request you may not decide, your own included where the policy forbids self-approval, and for one no longer pending.
The door of the portal’s POST /portal/access-requests.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
action |
one of approve, deny |
yes | approve or deny. |
request |
string | yes | The access request, from the list. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.enabled |
boolean | ||
view.rows |
list | ||
view.rows[].action |
any JSON | An AuthZEN Authorization API 1.0 member as the PEP sent it: its properties and its context are the caller’s to define. An AuthZEN Authorization API 1.0 member as the PEP sent it: its properties and its context are the caller’s to define. |
|
view.rows[].application |
string, or null | ||
view.rows[].approval |
object | ||
view.rows[].approval.approvedAt |
string or number, or null | ||
view.rows[].approval.approvedUntil |
string or number, or null | ||
view.rows[].approval.approver |
string, or null | ||
view.rows[].approval.id |
string | ||
view.rows[].approval.revoked |
boolean | ||
view.rows[].approvers |
object | ||
view.rows[].approvers.groups |
list | ||
view.rows[].approvers.groups[] |
string | ||
view.rows[].approvers.owners |
boolean | ||
view.rows[].approvers.roles |
list | ||
view.rows[].approvers.roles[] |
string | ||
view.rows[].client |
object | ||
view.rows[].client.id |
string | ||
view.rows[].client.name |
string | ||
view.rows[].context |
any JSON | An AuthZEN Authorization API 1.0 member as the PEP sent it: its properties and its context are the caller’s to define. An AuthZEN Authorization API 1.0 member as the PEP sent it: its properties and its context are the caller’s to define. |
|
view.rows[].createdAt |
string or number, or null | ||
view.rows[].decidedBy |
string | ||
view.rows[].emergency |
boolean | ||
view.rows[].expiresAt |
string or number, or null | ||
view.rows[].finishedAt |
string or number, or null | ||
view.rows[].id |
string | ||
view.rows[].justification |
string | ||
view.rows[].requester |
string, or null | ||
view.rows[].resource |
any JSON | An AuthZEN Authorization API 1.0 member as the PEP sent it: its properties and its context are the caller’s to define. An AuthZEN Authorization API 1.0 member as the PEP sent it: its properties and its context are the caller’s to define. |
|
view.rows[].status |
string | ||
view.rows[].subject |
any JSON | An AuthZEN Authorization API 1.0 member as the PEP sent it: its properties and its context are the caller’s to define. An AuthZEN Authorization API 1.0 member as the PEP sent it: its properties and its context are the caller’s to define. |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/activation
getActivation
Checks an activation link and answers the setup form
Takes no token: the link’s user and token are the credential. Spends nothing — a link opened by a prefetch or a mail scanner still works. Rate limited. Every failure answers the same sentence. The answer is the first step: the password rules, whether a passkey and an authenticator app are offered, and whether a passkey may be the only way in (passkeyAlone, #1135).
The door of the portal’s GET /portal/activate.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
user |
query | The username the link names. | ||
X-Link-Token |
header | string | The single-use secret the link carried in its fragment. | |
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
base |
string | ||
enrolment |
object | ||
enrolment.algorithm |
string | ||
enrolment.digits |
number | ||
enrolment.grouped |
string | ||
enrolment.issuer |
string | ||
enrolment.period |
number | ||
enrolment.qr |
string | ||
kinds |
list | ||
kinds[] |
string | ||
lanes |
list | ||
lanes[] |
string | ||
passkey |
boolean | ||
passkeyAlone |
boolean | ||
passkeyOffered |
boolean | ||
password |
boolean | ||
pending |
object | ||
pending.challenge |
string | ||
pending.display |
string | ||
pending.exclude |
list | ||
pending.exclude[] |
string | ||
pending.fallback |
object | ||
pending.fallback.asksPostQuantum |
boolean | ||
pending.fallback.classical |
boolean | ||
pending.fallback.retrying |
boolean | ||
pending.id |
string | ||
pending.kind |
string | ||
pending.lane |
string | ||
pending.options |
object | ||
pending.options.algorithms |
list | ||
pending.options.algorithms[] |
integer | ||
pending.options.attestation |
string | ||
pending.options.authenticatorSelection |
object | ||
pending.options.authenticatorSelection.authenticatorAttachment |
string | ||
pending.options.authenticatorSelection.requireResidentKey |
boolean | ||
pending.options.authenticatorSelection.residentKey |
string | ||
pending.options.authenticatorSelection.userVerification |
string | ||
pending.options.credProps |
boolean | ||
pending.options.hints |
list | ||
pending.options.hints[] |
string | ||
pending.options.minPinLength |
boolean | ||
pending.options.rp |
object | ||
pending.options.rp.id |
string | ||
pending.options.rp.name |
string | ||
pending.options.timeout |
number | ||
pending.rpId |
string | ||
pending.user |
string | ||
pending.userHandle |
string | ||
refused |
string | ||
rules |
object | ||
rules.enforced |
boolean | ||
rules.rules |
list | ||
rules.rules[] |
string | ||
secondStep |
boolean | ||
signIn |
string | ||
step |
string | ||
title |
string | ||
token |
string | ||
totpOffered |
boolean | ||
user |
string | ||
wantsTotp |
boolean | ||
warning |
string | ||
webauthnEnabled |
boolean | ||
withTotp |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.base |
string | ||
view.enrolment |
object | ||
view.enrolment.algorithm |
string | ||
view.enrolment.digits |
number | ||
view.enrolment.grouped |
string | ||
view.enrolment.issuer |
string | ||
view.enrolment.period |
number | ||
view.enrolment.qr |
string | ||
view.kinds |
list | ||
view.kinds[] |
string | ||
view.lanes |
list | ||
view.lanes[] |
string | ||
view.passkey |
boolean | ||
view.passkeyAlone |
boolean | ||
view.passkeyOffered |
boolean | ||
view.password |
boolean | ||
view.pending |
object | ||
view.pending.challenge |
string | ||
view.pending.display |
string | ||
view.pending.exclude |
list | ||
view.pending.exclude[] |
string | ||
view.pending.fallback |
object | ||
view.pending.fallback.asksPostQuantum |
boolean | ||
view.pending.fallback.classical |
boolean | ||
view.pending.fallback.retrying |
boolean | ||
view.pending.id |
string | ||
view.pending.kind |
string | ||
view.pending.lane |
string | ||
view.pending.options |
object | ||
view.pending.options.algorithms |
list | ||
view.pending.options.algorithms[] |
integer | ||
view.pending.options.attestation |
string | ||
view.pending.options.authenticatorSelection |
object | ||
view.pending.options.authenticatorSelection.authenticatorAttachment |
string | ||
view.pending.options.authenticatorSelection.requireResidentKey |
boolean | ||
view.pending.options.authenticatorSelection.residentKey |
string | ||
view.pending.options.authenticatorSelection.userVerification |
string | ||
view.pending.options.credProps |
boolean | ||
view.pending.options.hints |
list | ||
view.pending.options.hints[] |
string | ||
view.pending.options.minPinLength |
boolean | ||
view.pending.options.rp |
object | ||
view.pending.options.rp.id |
string | ||
view.pending.options.rp.name |
string | ||
view.pending.options.timeout |
number | ||
view.pending.rpId |
string | ||
view.pending.user |
string | ||
view.pending.userHandle |
string | ||
view.refused |
string | ||
view.rules |
object | ||
view.rules.enforced |
boolean | ||
view.rules.rules |
list | ||
view.rules.rules[] |
string | ||
view.secondStep |
boolean | ||
view.signIn |
string | ||
view.step |
string | ||
view.title |
string | ||
view.token |
string | ||
view.totpOffered |
boolean | ||
view.user |
string | ||
view.wantsTotp |
boolean | ||
view.warning |
string | ||
view.webauthnEnabled |
boolean | ||
view.withTotp |
boolean |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.base |
string | ||
view.enrolment |
object | ||
view.enrolment.algorithm |
string | ||
view.enrolment.digits |
number | ||
view.enrolment.grouped |
string | ||
view.enrolment.issuer |
string | ||
view.enrolment.period |
number | ||
view.enrolment.qr |
string | ||
view.kinds |
list | ||
view.kinds[] |
string | ||
view.lanes |
list | ||
view.lanes[] |
string | ||
view.passkey |
boolean | ||
view.passkeyAlone |
boolean | ||
view.passkeyOffered |
boolean | ||
view.password |
boolean | ||
view.pending |
object | ||
view.pending.challenge |
string | ||
view.pending.display |
string | ||
view.pending.exclude |
list | ||
view.pending.exclude[] |
string | ||
view.pending.fallback |
object | ||
view.pending.fallback.asksPostQuantum |
boolean | ||
view.pending.fallback.classical |
boolean | ||
view.pending.fallback.retrying |
boolean | ||
view.pending.id |
string | ||
view.pending.kind |
string | ||
view.pending.lane |
string | ||
view.pending.options |
object | ||
view.pending.options.algorithms |
list | ||
view.pending.options.algorithms[] |
integer | ||
view.pending.options.attestation |
string | ||
view.pending.options.authenticatorSelection |
object | ||
view.pending.options.authenticatorSelection.authenticatorAttachment |
string | ||
view.pending.options.authenticatorSelection.requireResidentKey |
boolean | ||
view.pending.options.authenticatorSelection.residentKey |
string | ||
view.pending.options.authenticatorSelection.userVerification |
string | ||
view.pending.options.credProps |
boolean | ||
view.pending.options.hints |
list | ||
view.pending.options.hints[] |
string | ||
view.pending.options.minPinLength |
boolean | ||
view.pending.options.rp |
object | ||
view.pending.options.rp.id |
string | ||
view.pending.options.rp.name |
string | ||
view.pending.options.timeout |
number | ||
view.pending.rpId |
string | ||
view.pending.user |
string | ||
view.pending.userHandle |
string | ||
view.refused |
string | ||
view.rules |
object | ||
view.rules.enforced |
boolean | ||
view.rules.rules |
list | ||
view.rules.rules[] |
string | ||
view.secondStep |
boolean | ||
view.signIn |
string | ||
view.step |
string | ||
view.title |
string | ||
view.token |
string | ||
view.totpOffered |
boolean | ||
view.user |
string | ||
view.wantsTotp |
boolean | ||
view.warning |
string | ||
view.webauthnEnabled |
boolean | ||
view.withTotp |
boolean |
POST /account-api/activation
activate
Answers one step of an activation
setup sets the password and starts a passkey (the key view) or an authenticator app (the totp view) where they were chosen; key answers the passkey’s ceremony; totp the app’s code. The link is checked again, claimed before anything is set, and spent only by the step that finishes, which answers the ready view. Nobody is signed in by it. A passkey carries no role (#1135): passkey asks for one, and key_role is still accepted, primary and mfa both asking for one.
The door of the portal’s POST /portal/activate.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
code |
string | totp: the code the authenticator app shows. |
|
confirm |
string | setup: the password again. |
|
credential |
string | key: the browser’s ceremony result, as JSON. |
|
enrolment_id |
``, or string | key: the pending registration. |
|
key_role |
``, or one of none, primary, mfa |
Before #1135: primary or mfa registers a passkey, none does not; passkey says the same. |
|
kind |
``, or one of passkey, security-key |
setup: where the passkey lives. |
|
lane |
``, or one of classical, pqc |
setup: classical (the default) or pqc, where the realm offers a post-quantum passkey beside a classical one. |
|
passkey |
``, or one of 0, 1, true, false, on, off, yes, no |
setup: 1 registers a passkey. |
|
password |
string | setup: the password to set. |
|
step |
``, or one of setup, key, totp |
Which step this answers. | |
token |
``, or string | The link’s single-use token. | |
totp |
``, or one of 0, 1, true, false, on, off, yes, no |
1: set up an authenticator app too. |
|
user |
``, or string | The username the link names. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean | ||
view |
object | ||
view.base |
string | ||
view.enrolment |
object | ||
view.enrolment.algorithm |
string | ||
view.enrolment.digits |
number | ||
view.enrolment.grouped |
string | ||
view.enrolment.issuer |
string | ||
view.enrolment.period |
number | ||
view.enrolment.qr |
string | ||
view.kinds |
list | ||
view.kinds[] |
string | ||
view.lanes |
list | ||
view.lanes[] |
string | ||
view.passkey |
boolean | ||
view.passkeyAlone |
boolean | ||
view.passkeyOffered |
boolean | ||
view.password |
boolean | ||
view.pending |
object | ||
view.pending.challenge |
string | ||
view.pending.display |
string | ||
view.pending.exclude |
list | ||
view.pending.exclude[] |
string | ||
view.pending.fallback |
object | ||
view.pending.fallback.asksPostQuantum |
boolean | ||
view.pending.fallback.classical |
boolean | ||
view.pending.fallback.retrying |
boolean | ||
view.pending.id |
string | ||
view.pending.kind |
string | ||
view.pending.lane |
string | ||
view.pending.options |
object | ||
view.pending.options.algorithms |
list | ||
view.pending.options.algorithms[] |
integer | ||
view.pending.options.attestation |
string | ||
view.pending.options.authenticatorSelection |
object | ||
view.pending.options.authenticatorSelection.authenticatorAttachment |
string | ||
view.pending.options.authenticatorSelection.requireResidentKey |
boolean | ||
view.pending.options.authenticatorSelection.residentKey |
string | ||
view.pending.options.authenticatorSelection.userVerification |
string | ||
view.pending.options.credProps |
boolean | ||
view.pending.options.hints |
list | ||
view.pending.options.hints[] |
string | ||
view.pending.options.minPinLength |
boolean | ||
view.pending.options.rp |
object | ||
view.pending.options.rp.id |
string | ||
view.pending.options.rp.name |
string | ||
view.pending.options.timeout |
number | ||
view.pending.rpId |
string | ||
view.pending.user |
string | ||
view.pending.userHandle |
string | ||
view.refused |
string | ||
view.rules |
object | ||
view.rules.enforced |
boolean | ||
view.rules.rules |
list | ||
view.rules.rules[] |
string | ||
view.secondStep |
boolean | ||
view.signIn |
string | ||
view.step |
string | ||
view.title |
string | ||
view.token |
string | ||
view.totpOffered |
boolean | ||
view.user |
string | ||
view.wantsTotp |
boolean | ||
view.warning |
string | ||
view.webauthnEnabled |
boolean | ||
view.withTotp |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.base |
string | ||
view.enrolment |
object | ||
view.enrolment.algorithm |
string | ||
view.enrolment.digits |
number | ||
view.enrolment.grouped |
string | ||
view.enrolment.issuer |
string | ||
view.enrolment.period |
number | ||
view.enrolment.qr |
string | ||
view.kinds |
list | ||
view.kinds[] |
string | ||
view.lanes |
list | ||
view.lanes[] |
string | ||
view.passkey |
boolean | ||
view.passkeyAlone |
boolean | ||
view.passkeyOffered |
boolean | ||
view.password |
boolean | ||
view.pending |
object | ||
view.pending.challenge |
string | ||
view.pending.display |
string | ||
view.pending.exclude |
list | ||
view.pending.exclude[] |
string | ||
view.pending.fallback |
object | ||
view.pending.fallback.asksPostQuantum |
boolean | ||
view.pending.fallback.classical |
boolean | ||
view.pending.fallback.retrying |
boolean | ||
view.pending.id |
string | ||
view.pending.kind |
string | ||
view.pending.lane |
string | ||
view.pending.options |
object | ||
view.pending.options.algorithms |
list | ||
view.pending.options.algorithms[] |
integer | ||
view.pending.options.attestation |
string | ||
view.pending.options.authenticatorSelection |
object | ||
view.pending.options.authenticatorSelection.authenticatorAttachment |
string | ||
view.pending.options.authenticatorSelection.requireResidentKey |
boolean | ||
view.pending.options.authenticatorSelection.residentKey |
string | ||
view.pending.options.authenticatorSelection.userVerification |
string | ||
view.pending.options.credProps |
boolean | ||
view.pending.options.hints |
list | ||
view.pending.options.hints[] |
string | ||
view.pending.options.minPinLength |
boolean | ||
view.pending.options.rp |
object | ||
view.pending.options.rp.id |
string | ||
view.pending.options.rp.name |
string | ||
view.pending.options.timeout |
number | ||
view.pending.rpId |
string | ||
view.pending.user |
string | ||
view.pending.userHandle |
string | ||
view.refused |
string | ||
view.rules |
object | ||
view.rules.enforced |
boolean | ||
view.rules.rules |
list | ||
view.rules.rules[] |
string | ||
view.secondStep |
boolean | ||
view.signIn |
string | ||
view.step |
string | ||
view.title |
string | ||
view.token |
string | ||
view.totpOffered |
boolean | ||
view.user |
string | ||
view.wantsTotp |
boolean | ||
view.warning |
string | ||
view.webauthnEnabled |
boolean | ||
view.withTotp |
boolean |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.base |
string | ||
view.enrolment |
object | ||
view.enrolment.algorithm |
string | ||
view.enrolment.digits |
number | ||
view.enrolment.grouped |
string | ||
view.enrolment.issuer |
string | ||
view.enrolment.period |
number | ||
view.enrolment.qr |
string | ||
view.kinds |
list | ||
view.kinds[] |
string | ||
view.lanes |
list | ||
view.lanes[] |
string | ||
view.passkey |
boolean | ||
view.passkeyAlone |
boolean | ||
view.passkeyOffered |
boolean | ||
view.password |
boolean | ||
view.pending |
object | ||
view.pending.challenge |
string | ||
view.pending.display |
string | ||
view.pending.exclude |
list | ||
view.pending.exclude[] |
string | ||
view.pending.fallback |
object | ||
view.pending.fallback.asksPostQuantum |
boolean | ||
view.pending.fallback.classical |
boolean | ||
view.pending.fallback.retrying |
boolean | ||
view.pending.id |
string | ||
view.pending.kind |
string | ||
view.pending.lane |
string | ||
view.pending.options |
object | ||
view.pending.options.algorithms |
list | ||
view.pending.options.algorithms[] |
integer | ||
view.pending.options.attestation |
string | ||
view.pending.options.authenticatorSelection |
object | ||
view.pending.options.authenticatorSelection.authenticatorAttachment |
string | ||
view.pending.options.authenticatorSelection.requireResidentKey |
boolean | ||
view.pending.options.authenticatorSelection.residentKey |
string | ||
view.pending.options.authenticatorSelection.userVerification |
string | ||
view.pending.options.credProps |
boolean | ||
view.pending.options.hints |
list | ||
view.pending.options.hints[] |
string | ||
view.pending.options.minPinLength |
boolean | ||
view.pending.options.rp |
object | ||
view.pending.options.rp.id |
string | ||
view.pending.options.rp.name |
string | ||
view.pending.options.timeout |
number | ||
view.pending.rpId |
string | ||
view.pending.user |
string | ||
view.pending.userHandle |
string | ||
view.refused |
string | ||
view.rules |
object | ||
view.rules.enforced |
boolean | ||
view.rules.rules |
list | ||
view.rules.rules[] |
string | ||
view.secondStep |
boolean | ||
view.signIn |
string | ||
view.step |
string | ||
view.title |
string | ||
view.token |
string | ||
view.totpOffered |
boolean | ||
view.user |
string | ||
view.wantsTotp |
boolean | ||
view.warning |
string | ||
view.webauthnEnabled |
boolean | ||
view.withTotp |
boolean |
GET /account-api/announcements
getAnnouncements
Announcements for everybody signed in to the portal
What an administrator broadcast to the user portal after since — the now this operation answered your tab’s first ask with — within ssf.announcementKeepS, oldest first. With no since it answers only now, so a tab shows what arrived after it signed in. everyMs is how often to ask again.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
since |
query | string | ||
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
announcements |
list | ||
announcements[].at |
string | ||
announcements[].id |
string | ||
announcements[].message |
string | ||
everyMs |
number | ||
now |
number |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/app-passwords
getAppPasswords
Your app passwords, and the doors that need one
Which of the five password-only doors refuse your own password (doors), the door table, the app passwords you hold (never their values), and whether making one is on.
The door of the portal’s GET /portal/app-passwords.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
doorLabels |
map | Each door’s label, by its id. | |
doorLabels.{key} |
string | ||
doorTable |
list | ||
doorTable[].id |
string | ||
doorTable[].label |
string | ||
doorTable[].what |
string | ||
doors |
object | ||
doors.applies |
boolean | ||
doors.refused |
list | ||
doors.refused[] |
string | ||
doors.secondFactor |
boolean | ||
enabled |
boolean | ||
fresh |
object | ||
fresh.doors |
list | ||
fresh.doors[] |
string | ||
fresh.id |
string | ||
fresh.name |
string | ||
fresh.password |
string | ||
maxName |
number | ||
passwords |
list | ||
passwords[].createdAt |
string or number, or null | ||
passwords[].doors |
list | ||
passwords[].doors[] |
string | ||
passwords[].id |
string | ||
passwords[].lastUsedAt |
string or number, or null | ||
passwords[].lastUsedDoor |
string | ||
passwords[].name |
string | ||
unreadable |
boolean | ||
username |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/app-passwords
changeAppPasswords
Makes or revokes one of your app passwords
create (rate limited) makes one for the doors whose door_<id> is on; the password is in the answer’s view.fresh, ONCE. revoke ends the one id names; an id that is not yours is answered as not found.
The door of the portal’s POST /portal/app-passwords.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
action |
``, or one of create, revoke |
create makes one; revoke ends the one id names. |
|
door_est |
``, or one of 0, 1, true, false, on, off, yes, no |
Accept the new password at the est door. | |
door_ldap |
``, or one of 0, 1, true, false, on, off, yes, no |
Accept the new password at the ldap door. | |
door_scim |
``, or one of 0, 1, true, false, on, off, yes, no |
Accept the new password at the scim door. | |
door_ssf |
``, or one of 0, 1, true, false, on, off, yes, no |
Accept the new password at the ssf door. | |
door_wstrust |
``, or one of 0, 1, true, false, on, off, yes, no |
Accept the new password at the wstrust door. | |
id |
string | The id of the app password to revoke. | |
name |
string | What the new password is for, in your words. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean | ||
stepUp |
object | ||
stepUp.acrValues |
string | ||
stepUp.maxAge |
number | ||
stepUp.prompt |
string | ||
view |
object | ||
view.doorLabels |
map | Each door’s label, by its id. | |
view.doorLabels.{key} |
string | ||
view.doorTable |
list | ||
view.doorTable[].id |
string | ||
view.doorTable[].label |
string | ||
view.doorTable[].what |
string | ||
view.doors |
object | ||
view.doors.applies |
boolean | ||
view.doors.refused |
list | ||
view.doors.refused[] |
string | ||
view.doors.secondFactor |
boolean | ||
view.enabled |
boolean | ||
view.fresh |
object | ||
view.fresh.doors |
list | ||
view.fresh.doors[] |
string | ||
view.fresh.id |
string | ||
view.fresh.name |
string | ||
view.fresh.password |
string | ||
view.maxName |
number | ||
view.passwords |
list | ||
view.passwords[].createdAt |
string or number, or null | ||
view.passwords[].doors |
list | ||
view.passwords[].doors[] |
string | ||
view.passwords[].id |
string | ||
view.passwords[].lastUsedAt |
string or number, or null | ||
view.passwords[].lastUsedDoor |
string | ||
view.passwords[].name |
string | ||
view.unreadable |
boolean | ||
view.username |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.doorLabels |
map | Each door’s label, by its id. | |
view.doorLabels.{key} |
string | ||
view.doorTable |
list | ||
view.doorTable[].id |
string | ||
view.doorTable[].label |
string | ||
view.doorTable[].what |
string | ||
view.doors |
object | ||
view.doors.applies |
boolean | ||
view.doors.refused |
list | ||
view.doors.refused[] |
string | ||
view.doors.secondFactor |
boolean | ||
view.enabled |
boolean | ||
view.fresh |
object | ||
view.fresh.doors |
list | ||
view.fresh.doors[] |
string | ||
view.fresh.id |
string | ||
view.fresh.name |
string | ||
view.fresh.password |
string | ||
view.maxName |
number | ||
view.passwords |
list | ||
view.passwords[].createdAt |
string or number, or null | ||
view.passwords[].doors |
list | ||
view.passwords[].doors[] |
string | ||
view.passwords[].id |
string | ||
view.passwords[].lastUsedAt |
string or number, or null | ||
view.passwords[].lastUsedDoor |
string | ||
view.passwords[].name |
string | ||
view.unreadable |
boolean | ||
view.username |
string |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
404: You hold no app password with that id.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.doorLabels |
map | Each door’s label, by its id. | |
view.doorLabels.{key} |
string | ||
view.doorTable |
list | ||
view.doorTable[].id |
string | ||
view.doorTable[].label |
string | ||
view.doorTable[].what |
string | ||
view.doors |
object | ||
view.doors.applies |
boolean | ||
view.doors.refused |
list | ||
view.doors.refused[] |
string | ||
view.doors.secondFactor |
boolean | ||
view.enabled |
boolean | ||
view.fresh |
object | ||
view.fresh.doors |
list | ||
view.fresh.doors[] |
string | ||
view.fresh.id |
string | ||
view.fresh.name |
string | ||
view.fresh.password |
string | ||
view.maxName |
number | ||
view.passwords |
list | ||
view.passwords[].createdAt |
string or number, or null | ||
view.passwords[].doors |
list | ||
view.passwords[].doors[] |
string | ||
view.passwords[].id |
string | ||
view.passwords[].lastUsedAt |
string or number, or null | ||
view.passwords[].lastUsedDoor |
string | ||
view.passwords[].name |
string | ||
view.unreadable |
boolean | ||
view.username |
string |
429: Too many made; try again later.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.doorLabels |
map | Each door’s label, by its id. | |
view.doorLabels.{key} |
string | ||
view.doorTable |
list | ||
view.doorTable[].id |
string | ||
view.doorTable[].label |
string | ||
view.doorTable[].what |
string | ||
view.doors |
object | ||
view.doors.applies |
boolean | ||
view.doors.refused |
list | ||
view.doors.refused[] |
string | ||
view.doors.secondFactor |
boolean | ||
view.enabled |
boolean | ||
view.fresh |
object | ||
view.fresh.doors |
list | ||
view.fresh.doors[] |
string | ||
view.fresh.id |
string | ||
view.fresh.name |
string | ||
view.fresh.password |
string | ||
view.maxName |
number | ||
view.passwords |
list | ||
view.passwords[].createdAt |
string or number, or null | ||
view.passwords[].doors |
list | ||
view.passwords[].doors[] |
string | ||
view.passwords[].id |
string | ||
view.passwords[].lastUsedAt |
string or number, or null | ||
view.passwords[].lastUsedDoor |
string | ||
view.passwords[].name |
string | ||
view.unreadable |
boolean | ||
view.username |
string |
GET /account-api/applications
getApplications
The applications you can be signed in to
Every registered application that is a sign-in destination (OpenID Connect, OAuth 2.0, SAML 2.0, SAML 1.1, WS-Federation) for which the issuance policy, asked as a dry run, permits you at least one family — its home page, the identity-provider-initiated sign-in links it offers (launches, each /launch/{app}?protocol=…), the families permitted and withheld. Twenty to a page; the counts of those refused and not evaluated are carried too.
The door of the portal’s GET /portal/applications.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
done |
query | string | ||
page |
query | The page of the list, 1 for the first. | ||
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
limit |
number | ||
notSignIn |
integer | ||
page |
integer | ||
pages |
integer | ||
refused |
integer | ||
rows |
list | ||
rows[].description |
string | ||
rows[].families |
list | ||
rows[].families[] |
string | ||
rows[].homePage |
string, or null | ||
rows[].identifier |
string | ||
rows[].launchable |
list | ||
rows[].launchable[] |
string | ||
rows[].launches |
list | ||
rows[].launches[].label |
string | ||
rows[].launches[].protocol |
string | ||
rows[].launches[].url |
string | ||
rows[].name |
string | ||
rows[].ways |
list | ||
rows[].ways[] |
string | ||
rows[].withheld |
list | ||
rows[].withheld[] |
string | ||
scanned |
integer | ||
total |
integer | ||
truncated |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/attributes
setCustomAttribute
Replaces your own values of one custom attribute
Writes values as every value the realm’s custom attribute attribute holds on your own entry, checked against its syntax; no values clears it. Only an attribute whose definition shows it on the portal and lets you edit it (customAttributes[].editable on the Overview). A value the realm’s attribute policy requires may not be emptied in product mode.
The door of the portal’s POST /portal/attributes.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
attribute |
string | yes | The custom attribute’s name, one this realm’s definition lets you edit on the portal. |
values |
list, or `` | ||
values[] |
string |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/certificates
getCertificates
Your certificates and the enrollment credentials you hold
The certificates ACME, EST and SCEP issued for your entry, your ACME account binding keys and SCEP challenge passwords (never their secrets), the EST and SCEP profiles you may ask for, the host names registered on your entry, and the addresses of each family in this realm. A family turned off is null.
The door of the portal’s GET /portal/certificates.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
acme |
object | ||
acme.keys |
list | ||
acme.keys[].boundAccount |
string, or null | ||
acme.keys[].boundAt |
string or number, or null | ||
acme.keys[].createdAt |
string or number, or null | ||
acme.keys[].createdBy |
string, or null | ||
acme.keys[].expiresAt |
string or number, or null | ||
acme.keys[].kid |
string | ||
acme.keys[].status |
string | ||
enrolled |
list | ||
enrolled[].certificatePem |
string | ||
enrolled[].chainPem |
list | ||
enrolled[].chainPem[] |
string | ||
enrolled[].expired |
boolean | ||
enrolled[].family |
string | ||
enrolled[].issuedAt |
string | ||
enrolled[].keyAlg |
string | ||
enrolled[].keySource |
string | ||
enrolled[].names |
list | ||
enrolled[].names[] |
string | ||
enrolled[].notAfter |
string | ||
enrolled[].notBefore |
string | ||
enrolled[].profile |
string | ||
enrolled[].replaces |
string, or null | ||
enrolled[].requestedBy |
object | ||
enrolled[].requestedBy.admin |
boolean | ||
enrolled[].requestedBy.id |
string | ||
enrolled[].requestedBy.kind |
string | ||
enrolled[].revoked |
object | ||
enrolled[].revoked.at |
string | ||
enrolled[].revoked.by |
string | ||
enrolled[].revoked.reason |
string | ||
enrolled[].serialHex |
string | ||
enrolled[].status |
string | ||
enrolled[].subject |
string | ||
enrolled[].thumbprint |
string | ||
enrolled[].via |
string | ||
est |
object | ||
est.profiles |
list | ||
est.profiles[] |
string | ||
familyLabels |
map | Each enrollment family’s label, by its id. | |
familyLabels.{key} |
string | ||
fresh |
object | ||
fresh.challenge |
string | ||
fresh.expiresAt |
string or number, or null | ||
fresh.hmacKey |
string | ||
fresh.kid |
string | ||
fresh.kind |
string | ||
fresh.plainScepUrl |
string | ||
fresh.profile |
string | ||
fresh.scepUrl |
string | ||
hostNames |
list | ||
hostNames[] |
string | ||
name |
string | ||
reasons |
list | ||
reasons[] |
string | ||
resolved |
boolean | ||
scep |
object | ||
scep.challenges |
list | ||
scep.challenges[].createdAt |
string or number, or null | ||
scep.challenges[].createdBy |
string, or null | ||
scep.challenges[].expiresAt |
string or number, or null | ||
scep.challenges[].id |
string | ||
scep.challenges[].profile |
string, or null | ||
scep.challenges[].status |
string | ||
scep.challenges[].usedAt |
string or number, or null | ||
scep.defaultProfile |
string, or null | ||
scep.profiles |
list | ||
scep.profiles[] |
string | ||
urls |
object | ||
urls.acmeDirectory |
string | ||
urls.est |
string | ||
urls.scep |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/certificates
changeCertificates
Makes or deletes an enrollment credential, or revokes a certificate
create-eab and create-challenge (rate limited) make an ACME account binding key or a SCEP challenge password for your entry; its secret is in the answer’s view.fresh, ONCE. delete-eab and delete-challenge remove an unused one of yours; revoke revokes a certificate issued for you. Anything that is not yours is answered as not found.
The door of the portal’s POST /portal/certificates.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
action |
``, or one of create-eab, delete-eab, create-challenge, delete-challenge, revoke |
What to do. | |
id |
string | The challenge password to delete. | |
kid |
string | The account binding key to delete. | |
profile |
``, or one of tls-server, tls-client, tls-server-client, digital-signature, key-encipherment, code-signing, email, timestamping, smartcard-logon, device |
The profile a new SCEP challenge is for. | |
reason |
``, or one of unspecified, keyCompromise, affiliationChanged, superseded, cessationOfOperation |
The RFC 5280 reason for a revocation. | |
serial |
string | The serial of the certificate to revoke. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean | ||
stepUp |
object | ||
stepUp.acrValues |
string | ||
stepUp.maxAge |
number | ||
stepUp.prompt |
string | ||
view |
object | ||
view.acme |
object | ||
view.acme.keys |
list | ||
view.acme.keys[].boundAccount |
string, or null | ||
view.acme.keys[].boundAt |
string or number, or null | ||
view.acme.keys[].createdAt |
string or number, or null | ||
view.acme.keys[].createdBy |
string, or null | ||
view.acme.keys[].expiresAt |
string or number, or null | ||
view.acme.keys[].kid |
string | ||
view.acme.keys[].status |
string | ||
view.enrolled |
list | ||
view.enrolled[].certificatePem |
string | ||
view.enrolled[].chainPem |
list | ||
view.enrolled[].chainPem[] |
string | ||
view.enrolled[].expired |
boolean | ||
view.enrolled[].family |
string | ||
view.enrolled[].issuedAt |
string | ||
view.enrolled[].keyAlg |
string | ||
view.enrolled[].keySource |
string | ||
view.enrolled[].names |
list | ||
view.enrolled[].names[] |
string | ||
view.enrolled[].notAfter |
string | ||
view.enrolled[].notBefore |
string | ||
view.enrolled[].profile |
string | ||
view.enrolled[].replaces |
string, or null | ||
view.enrolled[].requestedBy |
object | ||
view.enrolled[].requestedBy.admin |
boolean | ||
view.enrolled[].requestedBy.id |
string | ||
view.enrolled[].requestedBy.kind |
string | ||
view.enrolled[].revoked |
object | ||
view.enrolled[].revoked.at |
string | ||
view.enrolled[].revoked.by |
string | ||
view.enrolled[].revoked.reason |
string | ||
view.enrolled[].serialHex |
string | ||
view.enrolled[].status |
string | ||
view.enrolled[].subject |
string | ||
view.enrolled[].thumbprint |
string | ||
view.enrolled[].via |
string | ||
view.est |
object | ||
view.est.profiles |
list | ||
view.est.profiles[] |
string | ||
view.familyLabels |
map | Each enrollment family’s label, by its id. | |
view.familyLabels.{key} |
string | ||
view.fresh |
object | ||
view.fresh.challenge |
string | ||
view.fresh.expiresAt |
string or number, or null | ||
view.fresh.hmacKey |
string | ||
view.fresh.kid |
string | ||
view.fresh.kind |
string | ||
view.fresh.plainScepUrl |
string | ||
view.fresh.profile |
string | ||
view.fresh.scepUrl |
string | ||
view.hostNames |
list | ||
view.hostNames[] |
string | ||
view.name |
string | ||
view.reasons |
list | ||
view.reasons[] |
string | ||
view.resolved |
boolean | ||
view.scep |
object | ||
view.scep.challenges |
list | ||
view.scep.challenges[].createdAt |
string or number, or null | ||
view.scep.challenges[].createdBy |
string, or null | ||
view.scep.challenges[].expiresAt |
string or number, or null | ||
view.scep.challenges[].id |
string | ||
view.scep.challenges[].profile |
string, or null | ||
view.scep.challenges[].status |
string | ||
view.scep.challenges[].usedAt |
string or number, or null | ||
view.scep.defaultProfile |
string, or null | ||
view.scep.profiles |
list | ||
view.scep.profiles[] |
string | ||
view.urls |
object | ||
view.urls.acmeDirectory |
string | ||
view.urls.est |
string | ||
view.urls.scep |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.acme |
object | ||
view.acme.keys |
list | ||
view.acme.keys[].boundAccount |
string, or null | ||
view.acme.keys[].boundAt |
string or number, or null | ||
view.acme.keys[].createdAt |
string or number, or null | ||
view.acme.keys[].createdBy |
string, or null | ||
view.acme.keys[].expiresAt |
string or number, or null | ||
view.acme.keys[].kid |
string | ||
view.acme.keys[].status |
string | ||
view.enrolled |
list | ||
view.enrolled[].certificatePem |
string | ||
view.enrolled[].chainPem |
list | ||
view.enrolled[].chainPem[] |
string | ||
view.enrolled[].expired |
boolean | ||
view.enrolled[].family |
string | ||
view.enrolled[].issuedAt |
string | ||
view.enrolled[].keyAlg |
string | ||
view.enrolled[].keySource |
string | ||
view.enrolled[].names |
list | ||
view.enrolled[].names[] |
string | ||
view.enrolled[].notAfter |
string | ||
view.enrolled[].notBefore |
string | ||
view.enrolled[].profile |
string | ||
view.enrolled[].replaces |
string, or null | ||
view.enrolled[].requestedBy |
object | ||
view.enrolled[].requestedBy.admin |
boolean | ||
view.enrolled[].requestedBy.id |
string | ||
view.enrolled[].requestedBy.kind |
string | ||
view.enrolled[].revoked |
object | ||
view.enrolled[].revoked.at |
string | ||
view.enrolled[].revoked.by |
string | ||
view.enrolled[].revoked.reason |
string | ||
view.enrolled[].serialHex |
string | ||
view.enrolled[].status |
string | ||
view.enrolled[].subject |
string | ||
view.enrolled[].thumbprint |
string | ||
view.enrolled[].via |
string | ||
view.est |
object | ||
view.est.profiles |
list | ||
view.est.profiles[] |
string | ||
view.familyLabels |
map | Each enrollment family’s label, by its id. | |
view.familyLabels.{key} |
string | ||
view.fresh |
object | ||
view.fresh.challenge |
string | ||
view.fresh.expiresAt |
string or number, or null | ||
view.fresh.hmacKey |
string | ||
view.fresh.kid |
string | ||
view.fresh.kind |
string | ||
view.fresh.plainScepUrl |
string | ||
view.fresh.profile |
string | ||
view.fresh.scepUrl |
string | ||
view.hostNames |
list | ||
view.hostNames[] |
string | ||
view.name |
string | ||
view.reasons |
list | ||
view.reasons[] |
string | ||
view.resolved |
boolean | ||
view.scep |
object | ||
view.scep.challenges |
list | ||
view.scep.challenges[].createdAt |
string or number, or null | ||
view.scep.challenges[].createdBy |
string, or null | ||
view.scep.challenges[].expiresAt |
string or number, or null | ||
view.scep.challenges[].id |
string | ||
view.scep.challenges[].profile |
string, or null | ||
view.scep.challenges[].status |
string | ||
view.scep.challenges[].usedAt |
string or number, or null | ||
view.scep.defaultProfile |
string, or null | ||
view.scep.profiles |
list | ||
view.scep.profiles[] |
string | ||
view.urls |
object | ||
view.urls.acmeDirectory |
string | ||
view.urls.est |
string | ||
view.urls.scep |
string |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.acme |
object | ||
view.acme.keys |
list | ||
view.acme.keys[].boundAccount |
string, or null | ||
view.acme.keys[].boundAt |
string or number, or null | ||
view.acme.keys[].createdAt |
string or number, or null | ||
view.acme.keys[].createdBy |
string, or null | ||
view.acme.keys[].expiresAt |
string or number, or null | ||
view.acme.keys[].kid |
string | ||
view.acme.keys[].status |
string | ||
view.enrolled |
list | ||
view.enrolled[].certificatePem |
string | ||
view.enrolled[].chainPem |
list | ||
view.enrolled[].chainPem[] |
string | ||
view.enrolled[].expired |
boolean | ||
view.enrolled[].family |
string | ||
view.enrolled[].issuedAt |
string | ||
view.enrolled[].keyAlg |
string | ||
view.enrolled[].keySource |
string | ||
view.enrolled[].names |
list | ||
view.enrolled[].names[] |
string | ||
view.enrolled[].notAfter |
string | ||
view.enrolled[].notBefore |
string | ||
view.enrolled[].profile |
string | ||
view.enrolled[].replaces |
string, or null | ||
view.enrolled[].requestedBy |
object | ||
view.enrolled[].requestedBy.admin |
boolean | ||
view.enrolled[].requestedBy.id |
string | ||
view.enrolled[].requestedBy.kind |
string | ||
view.enrolled[].revoked |
object | ||
view.enrolled[].revoked.at |
string | ||
view.enrolled[].revoked.by |
string | ||
view.enrolled[].revoked.reason |
string | ||
view.enrolled[].serialHex |
string | ||
view.enrolled[].status |
string | ||
view.enrolled[].subject |
string | ||
view.enrolled[].thumbprint |
string | ||
view.enrolled[].via |
string | ||
view.est |
object | ||
view.est.profiles |
list | ||
view.est.profiles[] |
string | ||
view.familyLabels |
map | Each enrollment family’s label, by its id. | |
view.familyLabels.{key} |
string | ||
view.fresh |
object | ||
view.fresh.challenge |
string | ||
view.fresh.expiresAt |
string or number, or null | ||
view.fresh.hmacKey |
string | ||
view.fresh.kid |
string | ||
view.fresh.kind |
string | ||
view.fresh.plainScepUrl |
string | ||
view.fresh.profile |
string | ||
view.fresh.scepUrl |
string | ||
view.hostNames |
list | ||
view.hostNames[] |
string | ||
view.name |
string | ||
view.reasons |
list | ||
view.reasons[] |
string | ||
view.resolved |
boolean | ||
view.scep |
object | ||
view.scep.challenges |
list | ||
view.scep.challenges[].createdAt |
string or number, or null | ||
view.scep.challenges[].createdBy |
string, or null | ||
view.scep.challenges[].expiresAt |
string or number, or null | ||
view.scep.challenges[].id |
string | ||
view.scep.challenges[].profile |
string, or null | ||
view.scep.challenges[].status |
string | ||
view.scep.challenges[].usedAt |
string or number, or null | ||
view.scep.defaultProfile |
string, or null | ||
view.scep.profiles |
list | ||
view.scep.profiles[] |
string | ||
view.urls |
object | ||
view.urls.acmeDirectory |
string | ||
view.urls.est |
string | ||
view.urls.scep |
string |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.acme |
object | ||
view.acme.keys |
list | ||
view.acme.keys[].boundAccount |
string, or null | ||
view.acme.keys[].boundAt |
string or number, or null | ||
view.acme.keys[].createdAt |
string or number, or null | ||
view.acme.keys[].createdBy |
string, or null | ||
view.acme.keys[].expiresAt |
string or number, or null | ||
view.acme.keys[].kid |
string | ||
view.acme.keys[].status |
string | ||
view.enrolled |
list | ||
view.enrolled[].certificatePem |
string | ||
view.enrolled[].chainPem |
list | ||
view.enrolled[].chainPem[] |
string | ||
view.enrolled[].expired |
boolean | ||
view.enrolled[].family |
string | ||
view.enrolled[].issuedAt |
string | ||
view.enrolled[].keyAlg |
string | ||
view.enrolled[].keySource |
string | ||
view.enrolled[].names |
list | ||
view.enrolled[].names[] |
string | ||
view.enrolled[].notAfter |
string | ||
view.enrolled[].notBefore |
string | ||
view.enrolled[].profile |
string | ||
view.enrolled[].replaces |
string, or null | ||
view.enrolled[].requestedBy |
object | ||
view.enrolled[].requestedBy.admin |
boolean | ||
view.enrolled[].requestedBy.id |
string | ||
view.enrolled[].requestedBy.kind |
string | ||
view.enrolled[].revoked |
object | ||
view.enrolled[].revoked.at |
string | ||
view.enrolled[].revoked.by |
string | ||
view.enrolled[].revoked.reason |
string | ||
view.enrolled[].serialHex |
string | ||
view.enrolled[].status |
string | ||
view.enrolled[].subject |
string | ||
view.enrolled[].thumbprint |
string | ||
view.enrolled[].via |
string | ||
view.est |
object | ||
view.est.profiles |
list | ||
view.est.profiles[] |
string | ||
view.familyLabels |
map | Each enrollment family’s label, by its id. | |
view.familyLabels.{key} |
string | ||
view.fresh |
object | ||
view.fresh.challenge |
string | ||
view.fresh.expiresAt |
string or number, or null | ||
view.fresh.hmacKey |
string | ||
view.fresh.kid |
string | ||
view.fresh.kind |
string | ||
view.fresh.plainScepUrl |
string | ||
view.fresh.profile |
string | ||
view.fresh.scepUrl |
string | ||
view.hostNames |
list | ||
view.hostNames[] |
string | ||
view.name |
string | ||
view.reasons |
list | ||
view.reasons[] |
string | ||
view.resolved |
boolean | ||
view.scep |
object | ||
view.scep.challenges |
list | ||
view.scep.challenges[].createdAt |
string or number, or null | ||
view.scep.challenges[].createdBy |
string, or null | ||
view.scep.challenges[].expiresAt |
string or number, or null | ||
view.scep.challenges[].id |
string | ||
view.scep.challenges[].profile |
string, or null | ||
view.scep.challenges[].status |
string | ||
view.scep.challenges[].usedAt |
string or number, or null | ||
view.scep.defaultProfile |
string, or null | ||
view.scep.profiles |
list | ||
view.scep.profiles[] |
string | ||
view.urls |
object | ||
view.urls.acmeDirectory |
string | ||
view.urls.est |
string | ||
view.urls.scep |
string |
404: You hold no such credential or certificate.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.acme |
object | ||
view.acme.keys |
list | ||
view.acme.keys[].boundAccount |
string, or null | ||
view.acme.keys[].boundAt |
string or number, or null | ||
view.acme.keys[].createdAt |
string or number, or null | ||
view.acme.keys[].createdBy |
string, or null | ||
view.acme.keys[].expiresAt |
string or number, or null | ||
view.acme.keys[].kid |
string | ||
view.acme.keys[].status |
string | ||
view.enrolled |
list | ||
view.enrolled[].certificatePem |
string | ||
view.enrolled[].chainPem |
list | ||
view.enrolled[].chainPem[] |
string | ||
view.enrolled[].expired |
boolean | ||
view.enrolled[].family |
string | ||
view.enrolled[].issuedAt |
string | ||
view.enrolled[].keyAlg |
string | ||
view.enrolled[].keySource |
string | ||
view.enrolled[].names |
list | ||
view.enrolled[].names[] |
string | ||
view.enrolled[].notAfter |
string | ||
view.enrolled[].notBefore |
string | ||
view.enrolled[].profile |
string | ||
view.enrolled[].replaces |
string, or null | ||
view.enrolled[].requestedBy |
object | ||
view.enrolled[].requestedBy.admin |
boolean | ||
view.enrolled[].requestedBy.id |
string | ||
view.enrolled[].requestedBy.kind |
string | ||
view.enrolled[].revoked |
object | ||
view.enrolled[].revoked.at |
string | ||
view.enrolled[].revoked.by |
string | ||
view.enrolled[].revoked.reason |
string | ||
view.enrolled[].serialHex |
string | ||
view.enrolled[].status |
string | ||
view.enrolled[].subject |
string | ||
view.enrolled[].thumbprint |
string | ||
view.enrolled[].via |
string | ||
view.est |
object | ||
view.est.profiles |
list | ||
view.est.profiles[] |
string | ||
view.familyLabels |
map | Each enrollment family’s label, by its id. | |
view.familyLabels.{key} |
string | ||
view.fresh |
object | ||
view.fresh.challenge |
string | ||
view.fresh.expiresAt |
string or number, or null | ||
view.fresh.hmacKey |
string | ||
view.fresh.kid |
string | ||
view.fresh.kind |
string | ||
view.fresh.plainScepUrl |
string | ||
view.fresh.profile |
string | ||
view.fresh.scepUrl |
string | ||
view.hostNames |
list | ||
view.hostNames[] |
string | ||
view.name |
string | ||
view.reasons |
list | ||
view.reasons[] |
string | ||
view.resolved |
boolean | ||
view.scep |
object | ||
view.scep.challenges |
list | ||
view.scep.challenges[].createdAt |
string or number, or null | ||
view.scep.challenges[].createdBy |
string, or null | ||
view.scep.challenges[].expiresAt |
string or number, or null | ||
view.scep.challenges[].id |
string | ||
view.scep.challenges[].profile |
string, or null | ||
view.scep.challenges[].status |
string | ||
view.scep.challenges[].usedAt |
string or number, or null | ||
view.scep.defaultProfile |
string, or null | ||
view.scep.profiles |
list | ||
view.scep.profiles[] |
string | ||
view.urls |
object | ||
view.urls.acmeDirectory |
string | ||
view.urls.est |
string | ||
view.urls.scep |
string |
409: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.acme |
object | ||
view.acme.keys |
list | ||
view.acme.keys[].boundAccount |
string, or null | ||
view.acme.keys[].boundAt |
string or number, or null | ||
view.acme.keys[].createdAt |
string or number, or null | ||
view.acme.keys[].createdBy |
string, or null | ||
view.acme.keys[].expiresAt |
string or number, or null | ||
view.acme.keys[].kid |
string | ||
view.acme.keys[].status |
string | ||
view.enrolled |
list | ||
view.enrolled[].certificatePem |
string | ||
view.enrolled[].chainPem |
list | ||
view.enrolled[].chainPem[] |
string | ||
view.enrolled[].expired |
boolean | ||
view.enrolled[].family |
string | ||
view.enrolled[].issuedAt |
string | ||
view.enrolled[].keyAlg |
string | ||
view.enrolled[].keySource |
string | ||
view.enrolled[].names |
list | ||
view.enrolled[].names[] |
string | ||
view.enrolled[].notAfter |
string | ||
view.enrolled[].notBefore |
string | ||
view.enrolled[].profile |
string | ||
view.enrolled[].replaces |
string, or null | ||
view.enrolled[].requestedBy |
object | ||
view.enrolled[].requestedBy.admin |
boolean | ||
view.enrolled[].requestedBy.id |
string | ||
view.enrolled[].requestedBy.kind |
string | ||
view.enrolled[].revoked |
object | ||
view.enrolled[].revoked.at |
string | ||
view.enrolled[].revoked.by |
string | ||
view.enrolled[].revoked.reason |
string | ||
view.enrolled[].serialHex |
string | ||
view.enrolled[].status |
string | ||
view.enrolled[].subject |
string | ||
view.enrolled[].thumbprint |
string | ||
view.enrolled[].via |
string | ||
view.est |
object | ||
view.est.profiles |
list | ||
view.est.profiles[] |
string | ||
view.familyLabels |
map | Each enrollment family’s label, by its id. | |
view.familyLabels.{key} |
string | ||
view.fresh |
object | ||
view.fresh.challenge |
string | ||
view.fresh.expiresAt |
string or number, or null | ||
view.fresh.hmacKey |
string | ||
view.fresh.kid |
string | ||
view.fresh.kind |
string | ||
view.fresh.plainScepUrl |
string | ||
view.fresh.profile |
string | ||
view.fresh.scepUrl |
string | ||
view.hostNames |
list | ||
view.hostNames[] |
string | ||
view.name |
string | ||
view.reasons |
list | ||
view.reasons[] |
string | ||
view.resolved |
boolean | ||
view.scep |
object | ||
view.scep.challenges |
list | ||
view.scep.challenges[].createdAt |
string or number, or null | ||
view.scep.challenges[].createdBy |
string, or null | ||
view.scep.challenges[].expiresAt |
string or number, or null | ||
view.scep.challenges[].id |
string | ||
view.scep.challenges[].profile |
string, or null | ||
view.scep.challenges[].status |
string | ||
view.scep.challenges[].usedAt |
string or number, or null | ||
view.scep.defaultProfile |
string, or null | ||
view.scep.profiles |
list | ||
view.scep.profiles[] |
string | ||
view.urls |
object | ||
view.urls.acmeDirectory |
string | ||
view.urls.est |
string | ||
view.urls.scep |
string |
429: Too many made; try again later.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.acme |
object | ||
view.acme.keys |
list | ||
view.acme.keys[].boundAccount |
string, or null | ||
view.acme.keys[].boundAt |
string or number, or null | ||
view.acme.keys[].createdAt |
string or number, or null | ||
view.acme.keys[].createdBy |
string, or null | ||
view.acme.keys[].expiresAt |
string or number, or null | ||
view.acme.keys[].kid |
string | ||
view.acme.keys[].status |
string | ||
view.enrolled |
list | ||
view.enrolled[].certificatePem |
string | ||
view.enrolled[].chainPem |
list | ||
view.enrolled[].chainPem[] |
string | ||
view.enrolled[].expired |
boolean | ||
view.enrolled[].family |
string | ||
view.enrolled[].issuedAt |
string | ||
view.enrolled[].keyAlg |
string | ||
view.enrolled[].keySource |
string | ||
view.enrolled[].names |
list | ||
view.enrolled[].names[] |
string | ||
view.enrolled[].notAfter |
string | ||
view.enrolled[].notBefore |
string | ||
view.enrolled[].profile |
string | ||
view.enrolled[].replaces |
string, or null | ||
view.enrolled[].requestedBy |
object | ||
view.enrolled[].requestedBy.admin |
boolean | ||
view.enrolled[].requestedBy.id |
string | ||
view.enrolled[].requestedBy.kind |
string | ||
view.enrolled[].revoked |
object | ||
view.enrolled[].revoked.at |
string | ||
view.enrolled[].revoked.by |
string | ||
view.enrolled[].revoked.reason |
string | ||
view.enrolled[].serialHex |
string | ||
view.enrolled[].status |
string | ||
view.enrolled[].subject |
string | ||
view.enrolled[].thumbprint |
string | ||
view.enrolled[].via |
string | ||
view.est |
object | ||
view.est.profiles |
list | ||
view.est.profiles[] |
string | ||
view.familyLabels |
map | Each enrollment family’s label, by its id. | |
view.familyLabels.{key} |
string | ||
view.fresh |
object | ||
view.fresh.challenge |
string | ||
view.fresh.expiresAt |
string or number, or null | ||
view.fresh.hmacKey |
string | ||
view.fresh.kid |
string | ||
view.fresh.kind |
string | ||
view.fresh.plainScepUrl |
string | ||
view.fresh.profile |
string | ||
view.fresh.scepUrl |
string | ||
view.hostNames |
list | ||
view.hostNames[] |
string | ||
view.name |
string | ||
view.reasons |
list | ||
view.reasons[] |
string | ||
view.resolved |
boolean | ||
view.scep |
object | ||
view.scep.challenges |
list | ||
view.scep.challenges[].createdAt |
string or number, or null | ||
view.scep.challenges[].createdBy |
string, or null | ||
view.scep.challenges[].expiresAt |
string or number, or null | ||
view.scep.challenges[].id |
string | ||
view.scep.challenges[].profile |
string, or null | ||
view.scep.challenges[].status |
string | ||
view.scep.challenges[].usedAt |
string or number, or null | ||
view.scep.defaultProfile |
string, or null | ||
view.scep.profiles |
list | ||
view.scep.profiles[] |
string | ||
view.urls |
object | ||
view.urls.acmeDirectory |
string | ||
view.urls.est |
string | ||
view.urls.scep |
string |
500: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.acme |
object | ||
view.acme.keys |
list | ||
view.acme.keys[].boundAccount |
string, or null | ||
view.acme.keys[].boundAt |
string or number, or null | ||
view.acme.keys[].createdAt |
string or number, or null | ||
view.acme.keys[].createdBy |
string, or null | ||
view.acme.keys[].expiresAt |
string or number, or null | ||
view.acme.keys[].kid |
string | ||
view.acme.keys[].status |
string | ||
view.enrolled |
list | ||
view.enrolled[].certificatePem |
string | ||
view.enrolled[].chainPem |
list | ||
view.enrolled[].chainPem[] |
string | ||
view.enrolled[].expired |
boolean | ||
view.enrolled[].family |
string | ||
view.enrolled[].issuedAt |
string | ||
view.enrolled[].keyAlg |
string | ||
view.enrolled[].keySource |
string | ||
view.enrolled[].names |
list | ||
view.enrolled[].names[] |
string | ||
view.enrolled[].notAfter |
string | ||
view.enrolled[].notBefore |
string | ||
view.enrolled[].profile |
string | ||
view.enrolled[].replaces |
string, or null | ||
view.enrolled[].requestedBy |
object | ||
view.enrolled[].requestedBy.admin |
boolean | ||
view.enrolled[].requestedBy.id |
string | ||
view.enrolled[].requestedBy.kind |
string | ||
view.enrolled[].revoked |
object | ||
view.enrolled[].revoked.at |
string | ||
view.enrolled[].revoked.by |
string | ||
view.enrolled[].revoked.reason |
string | ||
view.enrolled[].serialHex |
string | ||
view.enrolled[].status |
string | ||
view.enrolled[].subject |
string | ||
view.enrolled[].thumbprint |
string | ||
view.enrolled[].via |
string | ||
view.est |
object | ||
view.est.profiles |
list | ||
view.est.profiles[] |
string | ||
view.familyLabels |
map | Each enrollment family’s label, by its id. | |
view.familyLabels.{key} |
string | ||
view.fresh |
object | ||
view.fresh.challenge |
string | ||
view.fresh.expiresAt |
string or number, or null | ||
view.fresh.hmacKey |
string | ||
view.fresh.kid |
string | ||
view.fresh.kind |
string | ||
view.fresh.plainScepUrl |
string | ||
view.fresh.profile |
string | ||
view.fresh.scepUrl |
string | ||
view.hostNames |
list | ||
view.hostNames[] |
string | ||
view.name |
string | ||
view.reasons |
list | ||
view.reasons[] |
string | ||
view.resolved |
boolean | ||
view.scep |
object | ||
view.scep.challenges |
list | ||
view.scep.challenges[].createdAt |
string or number, or null | ||
view.scep.challenges[].createdBy |
string, or null | ||
view.scep.challenges[].expiresAt |
string or number, or null | ||
view.scep.challenges[].id |
string | ||
view.scep.challenges[].profile |
string, or null | ||
view.scep.challenges[].status |
string | ||
view.scep.challenges[].usedAt |
string or number, or null | ||
view.scep.defaultProfile |
string, or null | ||
view.scep.profiles |
list | ||
view.scep.profiles[] |
string | ||
view.urls |
object | ||
view.urls.acmeDirectory |
string | ||
view.urls.est |
string | ||
view.urls.scep |
string |
503: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.acme |
object | ||
view.acme.keys |
list | ||
view.acme.keys[].boundAccount |
string, or null | ||
view.acme.keys[].boundAt |
string or number, or null | ||
view.acme.keys[].createdAt |
string or number, or null | ||
view.acme.keys[].createdBy |
string, or null | ||
view.acme.keys[].expiresAt |
string or number, or null | ||
view.acme.keys[].kid |
string | ||
view.acme.keys[].status |
string | ||
view.enrolled |
list | ||
view.enrolled[].certificatePem |
string | ||
view.enrolled[].chainPem |
list | ||
view.enrolled[].chainPem[] |
string | ||
view.enrolled[].expired |
boolean | ||
view.enrolled[].family |
string | ||
view.enrolled[].issuedAt |
string | ||
view.enrolled[].keyAlg |
string | ||
view.enrolled[].keySource |
string | ||
view.enrolled[].names |
list | ||
view.enrolled[].names[] |
string | ||
view.enrolled[].notAfter |
string | ||
view.enrolled[].notBefore |
string | ||
view.enrolled[].profile |
string | ||
view.enrolled[].replaces |
string, or null | ||
view.enrolled[].requestedBy |
object | ||
view.enrolled[].requestedBy.admin |
boolean | ||
view.enrolled[].requestedBy.id |
string | ||
view.enrolled[].requestedBy.kind |
string | ||
view.enrolled[].revoked |
object | ||
view.enrolled[].revoked.at |
string | ||
view.enrolled[].revoked.by |
string | ||
view.enrolled[].revoked.reason |
string | ||
view.enrolled[].serialHex |
string | ||
view.enrolled[].status |
string | ||
view.enrolled[].subject |
string | ||
view.enrolled[].thumbprint |
string | ||
view.enrolled[].via |
string | ||
view.est |
object | ||
view.est.profiles |
list | ||
view.est.profiles[] |
string | ||
view.familyLabels |
map | Each enrollment family’s label, by its id. | |
view.familyLabels.{key} |
string | ||
view.fresh |
object | ||
view.fresh.challenge |
string | ||
view.fresh.expiresAt |
string or number, or null | ||
view.fresh.hmacKey |
string | ||
view.fresh.kid |
string | ||
view.fresh.kind |
string | ||
view.fresh.plainScepUrl |
string | ||
view.fresh.profile |
string | ||
view.fresh.scepUrl |
string | ||
view.hostNames |
list | ||
view.hostNames[] |
string | ||
view.name |
string | ||
view.reasons |
list | ||
view.reasons[] |
string | ||
view.resolved |
boolean | ||
view.scep |
object | ||
view.scep.challenges |
list | ||
view.scep.challenges[].createdAt |
string or number, or null | ||
view.scep.challenges[].createdBy |
string, or null | ||
view.scep.challenges[].expiresAt |
string or number, or null | ||
view.scep.challenges[].id |
string | ||
view.scep.challenges[].profile |
string, or null | ||
view.scep.challenges[].status |
string | ||
view.scep.challenges[].usedAt |
string or number, or null | ||
view.scep.defaultProfile |
string, or null | ||
view.scep.profiles |
list | ||
view.scep.profiles[] |
string | ||
view.urls |
object | ||
view.urls.acmeDirectory |
string | ||
view.urls.est |
string | ||
view.urls.scep |
string |
GET /account-api/ciba
getSignInRequests
The sign-in requests waiting for you, and your user code
The CIBA requests a client made to sign you in elsewhere (each with its binding message, scopes, requested acr values and expiry), whether you have a CIBA user code, and the GNAP grants waiting for you as their owner — each right with field (the checkbox value) and limitsHtml (its limit controls). With stepup or gnapstepup the answer is only stepUp: sign in again with acrValues, prompt=login.
The door of the portal’s GET /portal/ciba.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
stepup |
query | string | A CIBA request id: answered stepUp, the sign-in again its acr values need. |
|
gnapstepup |
query | string | A waiting GNAP request id: answered stepUp, the sign-in again its rights need. |
|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
enabled |
boolean | ||
gnap |
list | ||
gnap[].acr |
list | ||
gnap[].acr[] |
string | ||
gnap[].client |
string, or null | ||
gnap[].declared |
boolean | ||
gnap[].display |
string, or null | ||
gnap[].expiresAt |
string or number, or null | ||
gnap[].id |
string | ||
gnap[].requestedBy |
string | ||
gnap[].rights |
list | ||
gnap[].rights[].field |
string | ||
gnap[].rights[].limitsHtml |
string | ||
gnap[].rights[].parts |
string | ||
gnap[].rights[].reference |
string | ||
gnap[].rights[].type |
string | ||
gnap[].subject |
boolean | ||
hasCode |
boolean | ||
requests |
list | ||
requests[].acrValues |
list | ||
requests[].acrValues[] |
string | ||
requests[].bindingMessage |
string | ||
requests[].clientName |
string, or null | ||
requests[].expiresAt |
string or number, or null | ||
requests[].id |
string | ||
requests[].requestContext |
list | ||
requests[].requestContext[].name |
string | ||
requests[].requestContext[].value |
string | ||
requests[].scope |
string, or null | ||
stepUp |
object | ||
stepUp.acrValues |
string | ||
stepUp.maxAge |
number | ||
stepUp.prompt |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/ciba
answerSignInRequest
Sets your user code, or answers a request
A JSON body: action — set-code (with code), clear-code, approve / deny (with the CIBA request’s id), or gnap-approve / gnap-deny (with the GNAP request’s id, the ticked right values, subject: "yes", and any lim_t<k>r<r>_<member> limit controls lowered). An approval stronger than the sign-on session proved is refused 403 with stepUp.
The door of the portal’s POST /portal/ciba.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
action |
one of set-code, clear-code, approve, deny, gnap-approve, gnap-deny |
yes | |
code |
string | Your user code. | |
id |
string | The request’s id. | |
right |
list, or string | ||
right[] |
string | ||
subject |
one of yes |
Release your identity (GNAP). |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
stepUp |
object | ||
stepUp.acrValues |
string | ||
stepUp.maxAge |
number | ||
stepUp.prompt |
string |
GET /account-api/claim-sources
getClaimSources
The Claims Providers you can link, and your links
providers: one page (paging, moved by page) of the Claims Providers this realm registered — each one’s id, name, issuer, the claims it supplies and whether they are aggregated or distributed — with your link (when, and whether it has gone stale) or null. linked counts your links over every page. done and problem, which the provider’s callback sends back, come back as notice and problem.
The door of the portal’s GET /portal/claim-sources.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
page |
query | Which page of providers. Clamped to the last. |
||
done |
query | string | What a finished link said, from the callback. | |
problem |
query | string | Why a link could not be finished, from the callback. | |
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
linked |
integer | ||
notice |
string | ||
paging |
object | ||
paging.page |
integer | ||
paging.pages |
integer | ||
paging.per |
integer | ||
paging.total |
integer | ||
problem |
string | ||
providers |
list | ||
providers[].claims |
list | ||
providers[].claims[] |
string | ||
providers[].delivery |
string, or null | ||
providers[].id |
string | ||
providers[].issuer |
string, or null | ||
providers[].link |
object | ||
providers[].link.linkedAt |
string or number, or null | ||
providers[].link.stale |
boolean | ||
providers[].name |
string, or null |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/claim-sources
linkClaimSource
Links or unlinks a Claims Provider
link answers location, the provider’s authorization endpoint (code flow with PKCE): send the browser there. The answer sets the sts_claim_link cookie, scoped to /portal/claim-sources/callback, which finishes the link only in the browser holding it, while the sign-on session this token was issued on is live. unlink removes the link.
The door of the portal’s POST /portal/claim-sources.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
action |
one of link, unlink |
yes | link starts the provider’s sign-in; unlink removes the link. |
id |
string | yes | The Claims Provider’s id. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
location |
string | ||
message |
string | ||
ok |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.linked |
integer | ||
view.notice |
string | ||
view.paging |
object | ||
view.paging.page |
integer | ||
view.paging.pages |
integer | ||
view.paging.per |
integer | ||
view.paging.total |
integer | ||
view.problem |
string | ||
view.providers |
list | ||
view.providers[].claims |
list | ||
view.providers[].claims[] |
string | ||
view.providers[].delivery |
string, or null | ||
view.providers[].id |
string | ||
view.providers[].issuer |
string, or null | ||
view.providers[].link |
object | ||
view.providers[].link.linkedAt |
string or number, or null | ||
view.providers[].link.stale |
boolean | ||
view.providers[].name |
string, or null |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/connected-accounts
getConnectedAccounts
The consumer providers you can connect, and yours
providers: every consumer or social provider this realm offers (#565), each one’s relationship id, name and provider, and whether your account is connected to it. done and problem, which a provider’s return sends back, come back as notice and problem.
The door of the portal’s GET /portal/connected-accounts.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
done |
query | string | The provider a finished connect connected, from its return. | |
problem |
query | string | Why a connect could not be finished, from its return. | |
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
connected |
integer | ||
notice |
string | ||
problem |
string | ||
providers |
list | ||
providers[].connected |
boolean | ||
providers[].id |
string | ||
providers[].name |
string, or null | ||
providers[].provider |
string, or null | ||
providers[].providerLabel |
string, or null |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/connected-accounts
connectAccount
Connects or disconnects a consumer provider
connect answers location, the provider’s authorization address: send the browser there. It needs a sign-on session whose risk is LOW or unscored, and an authentication within federation.connectRecentAuthMinutes — otherwise the answer is stepUp, a sign-in again. The answer sets the sts_fed_link cookie, which finishes the connect only in the browser holding it. disconnect removes your connection and ends the sessions it started; it is refused (409) while the connection is your only way to sign in — no password, passkey or other connection.
The door of the portal’s POST /portal/connected-accounts.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
action |
one of connect, disconnect |
yes | connect starts the provider’s sign-in; disconnect removes the connection. |
id |
string | yes | The provider relationship’s id. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
location |
string | ||
message |
string | ||
ok |
boolean | ||
stepUp |
object | ||
stepUp.acrValues |
string | ||
stepUp.maxAge |
number | ||
stepUp.prompt |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.connected |
integer | ||
view.notice |
string | ||
view.problem |
string | ||
view.providers |
list | ||
view.providers[].connected |
boolean | ||
view.providers[].id |
string | ||
view.providers[].name |
string, or null | ||
view.providers[].provider |
string, or null | ||
view.providers[].providerLabel |
string, or null |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.connected |
integer | ||
view.notice |
string | ||
view.problem |
string | ||
view.providers |
list | ||
view.providers[].connected |
boolean | ||
view.providers[].id |
string | ||
view.providers[].name |
string, or null | ||
view.providers[].provider |
string, or null | ||
view.providers[].providerLabel |
string, or null |
409: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.connected |
integer | ||
view.notice |
string | ||
view.problem |
string | ||
view.providers |
list | ||
view.providers[].connected |
boolean | ||
view.providers[].id |
string | ||
view.providers[].name |
string, or null | ||
view.providers[].provider |
string, or null | ||
view.providers[].providerLabel |
string, or null |
GET /account-api/consents
getConsents
What you have agreed each application may ask for
One page (paging) of groups, one per application you have consented to, the newest first: its client_id, its name, and each scope with when you agreed (a GeneralizedTime). administrative is every scope an application’s global consent answered for you that still stands, which is not yours to withdraw.
The door of the portal’s GET /portal/consents.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
page |
query | |||
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
administrative |
list | ||
administrative[].client |
string | ||
administrative[].name |
string | ||
administrative[].rows |
list | ||
administrative[].rows[].at |
string | ||
administrative[].rows[].scope |
string | ||
groups |
list | ||
groups[].client |
string | ||
groups[].name |
string | ||
groups[].rows |
list | ||
groups[].rows[].at |
string | ||
groups[].rows[].scope |
string | ||
paging |
object | ||
paging.page |
integer | ||
paging.pages |
integer | ||
paging.per |
integer | ||
paging.total |
integer |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/consents
withdrawConsent
Withdraws a consent of yours
One scope (action=scope) or everything an application holds (action=application). Every token that application holds for you under it is revoked, and a refresh token granted before is refused even after you agree again. A consent that is not on your own entry is refused.
The door of the portal’s POST /portal/consents.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
action |
one of scope, application |
yes | scope: withdraw one scope. application: withdraw everything one application holds. |
client |
string | yes | The application’s client_id. |
page |
``, or integer | The page of the list the form was on. | |
scope |
string | The scope, for action=scope. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.administrative |
list | ||
view.administrative[].client |
string | ||
view.administrative[].name |
string | ||
view.administrative[].rows |
list | ||
view.administrative[].rows[].at |
string | ||
view.administrative[].rows[].scope |
string | ||
view.groups |
list | ||
view.groups[].client |
string | ||
view.groups[].name |
string | ||
view.groups[].rows |
list | ||
view.groups[].rows[].at |
string | ||
view.groups[].rows[].scope |
string | ||
view.paging |
object | ||
view.paging.page |
integer | ||
view.paging.pages |
integer | ||
view.paging.per |
integer | ||
view.paging.total |
integer |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/credentials/offerable
getOfferableCredentials
The credentials you can put into your own wallet
configurations: each credential configuration this realm’s OpenID4VCI issuer offers — its credential_configuration_id (id), its format, the name its metadata gives it, and whether it names the issuer by DID. modes: the two pre-authorized offers, cross-device (Appendix H.2) and deferred (H.3). lifetimeSeconds: how long an offer and its code are honoured (oid4vci.offerTtlS). wallet: the configured web wallet a link opens, or empty. batchSize: how many copies of a credential one issuance gives your wallet, each bound to a different key of the wallet’s (oid4vci.batchSize, OpenID4VCI 1.0 section 8.2). issued: the credentials this realm still records as issued to you, ONE PER ISSUANCE, newest first — each one’s id, configuration, when it was issued and expires, its status (valid, suspended, revoked, removed by you, signed-out by a global sign-out, expired, or mixed where its copies differ, with counts), whether you can remove it, the last event your wallet reported to the Notification Endpoint (OpenID4VCI 1.0 section 11), and its copies: each one’s own id, position of of, state, the RFC 7638 thumbprint of the wallet key it is bound to (keyThumbprint), the holder’s DID where it is DID-bound, and its statusIndex. issued is one page of issuances (paging, moved by page, 20 to a page); paging.total counts them all. A token whose sub and person do not name each other is refused (STS-PORTAL-0617) rather than shown somebody else’s history, or nobody’s as an empty one.
The door of the portal’s GET /portal/wallet.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
page |
query | Which page of issued, newest first. Clamped to the last. |
||
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
batchSize |
number | ||
configurations |
list | ||
configurations[].defaultSigningAlg |
string | ||
configurations[].format |
string | ||
configurations[].id |
string | ||
configurations[].issuerDid |
boolean | ||
configurations[].name |
string | ||
configurations[].signingAlgs |
list | ||
configurations[].signingAlgs[].alg |
string | ||
configurations[].signingAlgs[].spec |
string | ||
configurations[].signingAlgs[].what |
string | ||
issued |
list | ||
issued[].configurationId |
string, or null | ||
issued[].copies |
list | ||
issued[].copies[].expiresAt |
string | ||
issued[].copies[].holderDid |
string, or null | ||
issued[].copies[].id |
string | ||
issued[].copies[].issuedAt |
string | ||
issued[].copies[].keyThumbprint |
string, or null | ||
issued[].copies[].of |
integer | ||
issued[].copies[].position |
integer | ||
issued[].copies[].removable |
boolean | ||
issued[].copies[].removedAt |
string | ||
issued[].copies[].status |
string | ||
issued[].copies[].statusIndex |
string or number, or null | ||
issued[].copies[].walletEvent |
string, or null | ||
issued[].copies[].walletEventAt |
string | ||
issued[].counts |
map | How many copies are in each status. | |
issued[].counts.{key} |
integer | ||
issued[].expiresAt |
string | ||
issued[].format |
string, or null | ||
issued[].id |
string | ||
issued[].issuedAt |
string | ||
issued[].name |
string | ||
issued[].removable |
boolean | ||
issued[].removedAt |
string | ||
issued[].status |
string | ||
issued[].walletEvent |
string, or null | ||
issued[].walletEventAt |
string | ||
lifetimeSeconds |
number | ||
modes |
list | ||
modes[] |
string | ||
offer |
object | ||
offer.byReference |
object | ||
offer.byReference.credentialOfferUri |
string | ||
offer.byReference.offerUri |
string | ||
offer.byReference.walletUrl |
string | ||
offer.byValue |
object | ||
offer.byValue.offerUri |
string | ||
offer.byValue.walletUrl |
string | ||
offer.configurationId |
string | ||
offer.credentialOffer |
object | ||
offer.credentialOffer.credential_configuration_ids |
list | ||
offer.credentialOffer.credential_configuration_ids[] |
string | ||
offer.credentialOffer.credential_issuer |
string | ||
offer.credentialOffer.grants |
object | ||
offer.credentialOffer.grants.authorization_code |
object | ||
offer.credentialOffer.grants.authorization_code.issuer_state |
string | ||
offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code |
object | ||
offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.pre-authorized_code |
string | ||
offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code |
object | ||
offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.description |
string | ||
offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.input_mode |
string | ||
offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.length |
integer | ||
offer.expiresAt |
string | ||
offer.mode |
string | ||
offer.signingAlg |
string | ||
offer.txCode |
string, or null | ||
paging |
object | ||
paging.page |
integer | ||
paging.pages |
integer | ||
paging.per |
integer | ||
paging.total |
integer | ||
wallet |
string, or null |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/credentials/offers
createCredentialOffer
Makes a Credential Offer for your own wallet
A pre-authorized Credential Offer (OpenID4VCI section 4.1, Appendix H.2 or H.3) of one configuration, about YOU — the token’s person; nobody else can be named. Answered once, in place: offer.credentialOffer, the offer by value (offer.byValue.offerUri, an openid-credential-offer:// URI, and walletUrl, the configured web wallet’s link) and by reference (offer.byReference, whose offerUri is short enough for a QR code, e.g. openid-credential-offer://?credential_offer_uri=https%3A%2F%2Fsts.example%2Foid4vci%2Fcredential-offer%2F3q2-7w...), when the offer and its code stop being honoured (expiresAt), and the Transaction Code (txCode, e.g. 40317) the wallet will ask for — shown to you, never carried in the offer. The offer is made on the sign-on session your token was issued on, which is reported over CAEP as session-presented (OpenID4VCI). The same offer is in view, for the page. signingAlg, optional, is the algorithm the credential is signed with — one of the configuration’s signingAlgs in the GET, the post-quantum ML-DSA, SLH-DSA and composite drafts among them for the JOSE formats; left out, the configured default.
The door of the portal’s POST /portal/wallet.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
configuration |
string | yes | The credential_configuration_id to offer, one of GET /account-api/credentials/offerable’s. |
mode |
one of cross-device, deferred |
yes | cross-device (Appendix H.2: issued as soon as the wallet asks) or deferred (H.3: the credential endpoint answers a transaction_id first). |
page |
``, or integer | Which page of issued, newest first. Clamped to the last. |
|
signingAlg |
string | The algorithm the credential is signed with, one of the configuration’s signingAlgs; left out or empty, the configured oid4vci.credentialSigningAlgorithm. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
offer |
object | ||
offer.byReference |
object | ||
offer.byReference.credentialOfferUri |
string | ||
offer.byReference.offerUri |
string | ||
offer.byReference.walletUrl |
string | ||
offer.byValue |
object | ||
offer.byValue.offerUri |
string | ||
offer.byValue.walletUrl |
string | ||
offer.configurationId |
string | ||
offer.credentialOffer |
object | ||
offer.credentialOffer.credential_configuration_ids |
list | ||
offer.credentialOffer.credential_configuration_ids[] |
string | ||
offer.credentialOffer.credential_issuer |
string | ||
offer.credentialOffer.grants |
object | ||
offer.credentialOffer.grants.authorization_code |
object | ||
offer.credentialOffer.grants.authorization_code.issuer_state |
string | ||
offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code |
object | ||
offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.pre-authorized_code |
string | ||
offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code |
object | ||
offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.description |
string | ||
offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.input_mode |
string | ||
offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.length |
integer | ||
offer.expiresAt |
string | ||
offer.mode |
string | ||
offer.signingAlg |
string | ||
offer.txCode |
string, or null | ||
ok |
boolean | ||
stepUp |
object | ||
stepUp.acrValues |
string | ||
stepUp.maxAge |
number | ||
stepUp.prompt |
string | ||
view |
object | ||
view.batchSize |
number | ||
view.configurations |
list | ||
view.configurations[].defaultSigningAlg |
string | ||
view.configurations[].format |
string | ||
view.configurations[].id |
string | ||
view.configurations[].issuerDid |
boolean | ||
view.configurations[].name |
string | ||
view.configurations[].signingAlgs |
list | ||
view.configurations[].signingAlgs[].alg |
string | ||
view.configurations[].signingAlgs[].spec |
string | ||
view.configurations[].signingAlgs[].what |
string | ||
view.issued |
list | ||
view.issued[].configurationId |
string, or null | ||
view.issued[].copies |
list | ||
view.issued[].copies[].expiresAt |
string | ||
view.issued[].copies[].holderDid |
string, or null | ||
view.issued[].copies[].id |
string | ||
view.issued[].copies[].issuedAt |
string | ||
view.issued[].copies[].keyThumbprint |
string, or null | ||
view.issued[].copies[].of |
integer | ||
view.issued[].copies[].position |
integer | ||
view.issued[].copies[].removable |
boolean | ||
view.issued[].copies[].removedAt |
string | ||
view.issued[].copies[].status |
string | ||
view.issued[].copies[].statusIndex |
string or number, or null | ||
view.issued[].copies[].walletEvent |
string, or null | ||
view.issued[].copies[].walletEventAt |
string | ||
view.issued[].counts |
map | How many copies are in each status. | |
view.issued[].counts.{key} |
integer | ||
view.issued[].expiresAt |
string | ||
view.issued[].format |
string, or null | ||
view.issued[].id |
string | ||
view.issued[].issuedAt |
string | ||
view.issued[].name |
string | ||
view.issued[].removable |
boolean | ||
view.issued[].removedAt |
string | ||
view.issued[].status |
string | ||
view.issued[].walletEvent |
string, or null | ||
view.issued[].walletEventAt |
string | ||
view.lifetimeSeconds |
number | ||
view.modes |
list | ||
view.modes[] |
string | ||
view.offer |
object | ||
view.offer.byReference |
object | ||
view.offer.byReference.credentialOfferUri |
string | ||
view.offer.byReference.offerUri |
string | ||
view.offer.byReference.walletUrl |
string | ||
view.offer.byValue |
object | ||
view.offer.byValue.offerUri |
string | ||
view.offer.byValue.walletUrl |
string | ||
view.offer.configurationId |
string | ||
view.offer.credentialOffer |
object | ||
view.offer.credentialOffer.credential_configuration_ids |
list | ||
view.offer.credentialOffer.credential_configuration_ids[] |
string | ||
view.offer.credentialOffer.credential_issuer |
string | ||
view.offer.credentialOffer.grants |
object | ||
view.offer.credentialOffer.grants.authorization_code |
object | ||
view.offer.credentialOffer.grants.authorization_code.issuer_state |
string | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code |
object | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.pre-authorized_code |
string | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code |
object | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.description |
string | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.input_mode |
string | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.length |
integer | ||
view.offer.expiresAt |
string | ||
view.offer.mode |
string | ||
view.offer.signingAlg |
string | ||
view.offer.txCode |
string, or null | ||
view.paging |
object | ||
view.paging.page |
integer | ||
view.paging.pages |
integer | ||
view.paging.per |
integer | ||
view.paging.total |
integer | ||
view.wallet |
string, or null |
400: The configuration is not one this issuer offers (STS-PORTAL-0589), or its credentials are not signed with the signingAlg asked for (STS-PORTAL-0592).
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.batchSize |
number | ||
view.configurations |
list | ||
view.configurations[].defaultSigningAlg |
string | ||
view.configurations[].format |
string | ||
view.configurations[].id |
string | ||
view.configurations[].issuerDid |
boolean | ||
view.configurations[].name |
string | ||
view.configurations[].signingAlgs |
list | ||
view.configurations[].signingAlgs[].alg |
string | ||
view.configurations[].signingAlgs[].spec |
string | ||
view.configurations[].signingAlgs[].what |
string | ||
view.issued |
list | ||
view.issued[].configurationId |
string, or null | ||
view.issued[].copies |
list | ||
view.issued[].copies[].expiresAt |
string | ||
view.issued[].copies[].holderDid |
string, or null | ||
view.issued[].copies[].id |
string | ||
view.issued[].copies[].issuedAt |
string | ||
view.issued[].copies[].keyThumbprint |
string, or null | ||
view.issued[].copies[].of |
integer | ||
view.issued[].copies[].position |
integer | ||
view.issued[].copies[].removable |
boolean | ||
view.issued[].copies[].removedAt |
string | ||
view.issued[].copies[].status |
string | ||
view.issued[].copies[].statusIndex |
string or number, or null | ||
view.issued[].copies[].walletEvent |
string, or null | ||
view.issued[].copies[].walletEventAt |
string | ||
view.issued[].counts |
map | How many copies are in each status. | |
view.issued[].counts.{key} |
integer | ||
view.issued[].expiresAt |
string | ||
view.issued[].format |
string, or null | ||
view.issued[].id |
string | ||
view.issued[].issuedAt |
string | ||
view.issued[].name |
string | ||
view.issued[].removable |
boolean | ||
view.issued[].removedAt |
string | ||
view.issued[].status |
string | ||
view.issued[].walletEvent |
string, or null | ||
view.issued[].walletEventAt |
string | ||
view.lifetimeSeconds |
number | ||
view.modes |
list | ||
view.modes[] |
string | ||
view.offer |
object | ||
view.offer.byReference |
object | ||
view.offer.byReference.credentialOfferUri |
string | ||
view.offer.byReference.offerUri |
string | ||
view.offer.byReference.walletUrl |
string | ||
view.offer.byValue |
object | ||
view.offer.byValue.offerUri |
string | ||
view.offer.byValue.walletUrl |
string | ||
view.offer.configurationId |
string | ||
view.offer.credentialOffer |
object | ||
view.offer.credentialOffer.credential_configuration_ids |
list | ||
view.offer.credentialOffer.credential_configuration_ids[] |
string | ||
view.offer.credentialOffer.credential_issuer |
string | ||
view.offer.credentialOffer.grants |
object | ||
view.offer.credentialOffer.grants.authorization_code |
object | ||
view.offer.credentialOffer.grants.authorization_code.issuer_state |
string | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code |
object | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.pre-authorized_code |
string | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code |
object | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.description |
string | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.input_mode |
string | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.length |
integer | ||
view.offer.expiresAt |
string | ||
view.offer.mode |
string | ||
view.offer.signingAlg |
string | ||
view.offer.txCode |
string, or null | ||
view.paging |
object | ||
view.paging.page |
integer | ||
view.paging.pages |
integer | ||
view.paging.per |
integer | ||
view.paging.total |
integer | ||
view.wallet |
string, or null |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.batchSize |
number | ||
view.configurations |
list | ||
view.configurations[].defaultSigningAlg |
string | ||
view.configurations[].format |
string | ||
view.configurations[].id |
string | ||
view.configurations[].issuerDid |
boolean | ||
view.configurations[].name |
string | ||
view.configurations[].signingAlgs |
list | ||
view.configurations[].signingAlgs[].alg |
string | ||
view.configurations[].signingAlgs[].spec |
string | ||
view.configurations[].signingAlgs[].what |
string | ||
view.issued |
list | ||
view.issued[].configurationId |
string, or null | ||
view.issued[].copies |
list | ||
view.issued[].copies[].expiresAt |
string | ||
view.issued[].copies[].holderDid |
string, or null | ||
view.issued[].copies[].id |
string | ||
view.issued[].copies[].issuedAt |
string | ||
view.issued[].copies[].keyThumbprint |
string, or null | ||
view.issued[].copies[].of |
integer | ||
view.issued[].copies[].position |
integer | ||
view.issued[].copies[].removable |
boolean | ||
view.issued[].copies[].removedAt |
string | ||
view.issued[].copies[].status |
string | ||
view.issued[].copies[].statusIndex |
string or number, or null | ||
view.issued[].copies[].walletEvent |
string, or null | ||
view.issued[].copies[].walletEventAt |
string | ||
view.issued[].counts |
map | How many copies are in each status. | |
view.issued[].counts.{key} |
integer | ||
view.issued[].expiresAt |
string | ||
view.issued[].format |
string, or null | ||
view.issued[].id |
string | ||
view.issued[].issuedAt |
string | ||
view.issued[].name |
string | ||
view.issued[].removable |
boolean | ||
view.issued[].removedAt |
string | ||
view.issued[].status |
string | ||
view.issued[].walletEvent |
string, or null | ||
view.issued[].walletEventAt |
string | ||
view.lifetimeSeconds |
number | ||
view.modes |
list | ||
view.modes[] |
string | ||
view.offer |
object | ||
view.offer.byReference |
object | ||
view.offer.byReference.credentialOfferUri |
string | ||
view.offer.byReference.offerUri |
string | ||
view.offer.byReference.walletUrl |
string | ||
view.offer.byValue |
object | ||
view.offer.byValue.offerUri |
string | ||
view.offer.byValue.walletUrl |
string | ||
view.offer.configurationId |
string | ||
view.offer.credentialOffer |
object | ||
view.offer.credentialOffer.credential_configuration_ids |
list | ||
view.offer.credentialOffer.credential_configuration_ids[] |
string | ||
view.offer.credentialOffer.credential_issuer |
string | ||
view.offer.credentialOffer.grants |
object | ||
view.offer.credentialOffer.grants.authorization_code |
object | ||
view.offer.credentialOffer.grants.authorization_code.issuer_state |
string | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code |
object | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.pre-authorized_code |
string | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code |
object | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.description |
string | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.input_mode |
string | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.length |
integer | ||
view.offer.expiresAt |
string | ||
view.offer.mode |
string | ||
view.offer.signingAlg |
string | ||
view.offer.txCode |
string, or null | ||
view.paging |
object | ||
view.paging.page |
integer | ||
view.paging.pages |
integer | ||
view.paging.per |
integer | ||
view.paging.total |
integer | ||
view.wallet |
string, or null |
POST /account-api/credentials/remove
removeIssuedCredential
Removes a credential issued to you: every copy, or one
The credential named by its id is revoked. An issuance’s id (from issued) names every copy of it — with batch issuance one issuance gives your wallet several copies, each bound to a different key — and removes each copy still good; a copy’s id (from that issuance’s copies) removes that copy alone and leaves the others as they are. Each copy removed has its Token Status List entry set INVALID, which is final and what a verifier reads, is marked revoked in the issued register and no longer signs you in; your relying parties are told once over CAEP (credential-change, revoke). It is NOT deleted from your wallet: neither OpenID4VP nor OpenID4VCI lets an issuer do that, so delete it in the wallet yourself. Only a credential of yours can be named; removing one already removed is answered as done. scope says what the id named and removed how many copies this act removed; the page’s view is in the answer.
The door of the portal’s POST /portal/remove-wallet-credential.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
id |
string | yes | An issuance’s id, from issued in GET /account-api/credentials/offerable, which removes every copy of it; or one copy’s, from its copies, which removes that copy alone. |
page |
``, or integer | Which page of issued, newest first. Clamped to the last. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean | ||
removed |
integer | ||
scope |
string | ||
view |
object | ||
view.batchSize |
number | ||
view.configurations |
list | ||
view.configurations[].defaultSigningAlg |
string | ||
view.configurations[].format |
string | ||
view.configurations[].id |
string | ||
view.configurations[].issuerDid |
boolean | ||
view.configurations[].name |
string | ||
view.configurations[].signingAlgs |
list | ||
view.configurations[].signingAlgs[].alg |
string | ||
view.configurations[].signingAlgs[].spec |
string | ||
view.configurations[].signingAlgs[].what |
string | ||
view.issued |
list | ||
view.issued[].configurationId |
string, or null | ||
view.issued[].copies |
list | ||
view.issued[].copies[].expiresAt |
string | ||
view.issued[].copies[].holderDid |
string, or null | ||
view.issued[].copies[].id |
string | ||
view.issued[].copies[].issuedAt |
string | ||
view.issued[].copies[].keyThumbprint |
string, or null | ||
view.issued[].copies[].of |
integer | ||
view.issued[].copies[].position |
integer | ||
view.issued[].copies[].removable |
boolean | ||
view.issued[].copies[].removedAt |
string | ||
view.issued[].copies[].status |
string | ||
view.issued[].copies[].statusIndex |
string or number, or null | ||
view.issued[].copies[].walletEvent |
string, or null | ||
view.issued[].copies[].walletEventAt |
string | ||
view.issued[].counts |
map | How many copies are in each status. | |
view.issued[].counts.{key} |
integer | ||
view.issued[].expiresAt |
string | ||
view.issued[].format |
string, or null | ||
view.issued[].id |
string | ||
view.issued[].issuedAt |
string | ||
view.issued[].name |
string | ||
view.issued[].removable |
boolean | ||
view.issued[].removedAt |
string | ||
view.issued[].status |
string | ||
view.issued[].walletEvent |
string, or null | ||
view.issued[].walletEventAt |
string | ||
view.lifetimeSeconds |
number | ||
view.modes |
list | ||
view.modes[] |
string | ||
view.offer |
object | ||
view.offer.byReference |
object | ||
view.offer.byReference.credentialOfferUri |
string | ||
view.offer.byReference.offerUri |
string | ||
view.offer.byReference.walletUrl |
string | ||
view.offer.byValue |
object | ||
view.offer.byValue.offerUri |
string | ||
view.offer.byValue.walletUrl |
string | ||
view.offer.configurationId |
string | ||
view.offer.credentialOffer |
object | ||
view.offer.credentialOffer.credential_configuration_ids |
list | ||
view.offer.credentialOffer.credential_configuration_ids[] |
string | ||
view.offer.credentialOffer.credential_issuer |
string | ||
view.offer.credentialOffer.grants |
object | ||
view.offer.credentialOffer.grants.authorization_code |
object | ||
view.offer.credentialOffer.grants.authorization_code.issuer_state |
string | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code |
object | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.pre-authorized_code |
string | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code |
object | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.description |
string | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.input_mode |
string | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.length |
integer | ||
view.offer.expiresAt |
string | ||
view.offer.mode |
string | ||
view.offer.signingAlg |
string | ||
view.offer.txCode |
string, or null | ||
view.paging |
object | ||
view.paging.page |
integer | ||
view.paging.pages |
integer | ||
view.paging.per |
integer | ||
view.paging.total |
integer | ||
view.wallet |
string, or null |
400: No credential or issuance of yours has that id (STS-PORTAL-0591).
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.batchSize |
number | ||
view.configurations |
list | ||
view.configurations[].defaultSigningAlg |
string | ||
view.configurations[].format |
string | ||
view.configurations[].id |
string | ||
view.configurations[].issuerDid |
boolean | ||
view.configurations[].name |
string | ||
view.configurations[].signingAlgs |
list | ||
view.configurations[].signingAlgs[].alg |
string | ||
view.configurations[].signingAlgs[].spec |
string | ||
view.configurations[].signingAlgs[].what |
string | ||
view.issued |
list | ||
view.issued[].configurationId |
string, or null | ||
view.issued[].copies |
list | ||
view.issued[].copies[].expiresAt |
string | ||
view.issued[].copies[].holderDid |
string, or null | ||
view.issued[].copies[].id |
string | ||
view.issued[].copies[].issuedAt |
string | ||
view.issued[].copies[].keyThumbprint |
string, or null | ||
view.issued[].copies[].of |
integer | ||
view.issued[].copies[].position |
integer | ||
view.issued[].copies[].removable |
boolean | ||
view.issued[].copies[].removedAt |
string | ||
view.issued[].copies[].status |
string | ||
view.issued[].copies[].statusIndex |
string or number, or null | ||
view.issued[].copies[].walletEvent |
string, or null | ||
view.issued[].copies[].walletEventAt |
string | ||
view.issued[].counts |
map | How many copies are in each status. | |
view.issued[].counts.{key} |
integer | ||
view.issued[].expiresAt |
string | ||
view.issued[].format |
string, or null | ||
view.issued[].id |
string | ||
view.issued[].issuedAt |
string | ||
view.issued[].name |
string | ||
view.issued[].removable |
boolean | ||
view.issued[].removedAt |
string | ||
view.issued[].status |
string | ||
view.issued[].walletEvent |
string, or null | ||
view.issued[].walletEventAt |
string | ||
view.lifetimeSeconds |
number | ||
view.modes |
list | ||
view.modes[] |
string | ||
view.offer |
object | ||
view.offer.byReference |
object | ||
view.offer.byReference.credentialOfferUri |
string | ||
view.offer.byReference.offerUri |
string | ||
view.offer.byReference.walletUrl |
string | ||
view.offer.byValue |
object | ||
view.offer.byValue.offerUri |
string | ||
view.offer.byValue.walletUrl |
string | ||
view.offer.configurationId |
string | ||
view.offer.credentialOffer |
object | ||
view.offer.credentialOffer.credential_configuration_ids |
list | ||
view.offer.credentialOffer.credential_configuration_ids[] |
string | ||
view.offer.credentialOffer.credential_issuer |
string | ||
view.offer.credentialOffer.grants |
object | ||
view.offer.credentialOffer.grants.authorization_code |
object | ||
view.offer.credentialOffer.grants.authorization_code.issuer_state |
string | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code |
object | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.pre-authorized_code |
string | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code |
object | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.description |
string | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.input_mode |
string | ||
view.offer.credentialOffer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.length |
integer | ||
view.offer.expiresAt |
string | ||
view.offer.mode |
string | ||
view.offer.signingAlg |
string | ||
view.offer.txCode |
string, or null | ||
view.paging |
object | ||
view.paging.page |
integer | ||
view.paging.pages |
integer | ||
view.paging.per |
integer | ||
view.paging.total |
integer | ||
view.wallet |
string, or null |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/delegate
getDelegate
Who may act for you
mayAct, the DN named in your entry’s stsMayAct (every access token about you carries it as RFC 8693 may_act), delegate.kind (person or application, null where the DN names no entry any more), and notDelegated, whether your account refuses delegation.
The door of the portal’s GET /portal/delegate.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
delegate |
object | ||
delegate.kind |
string | ||
mayAct |
string | ||
notDelegated |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/delegate
setDelegate
Names, or clears, who may act for you
Writes stsMayAct on your own entry: a person or an application of this realm, by DN. A token exchange presenting a token about you is then refused for any other actor.
The door of the portal’s POST /portal/delegate.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
action |
``, or one of set, clear |
set names the delegate; clear removes it. |
|
delegate |
string | The DN of a person or an application in this realm, for action=set. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.delegate |
object | ||
view.delegate.kind |
string | ||
view.mayAct |
string | ||
view.notDelegated |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/delegate/candidates
findDelegateCandidates
Finds people you may name, by part of their username
The people of this realm whose username (uid, the RDN value of their entry) contains q, at least three characters: native people only — never one a federation partner’s or a consumer provider’s sign-in created — and never you, a disabled account, a service account, a group or an application. At most ten, each { uid, cn, dn } and nothing else; more says more matched, and a narrower q finds them. Naming one is POST /account-api/delegate with its dn.
The door of the portal’s GET /portal/delegate/candidates.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
q |
query | string | yes | Part of a username (uid), at least three characters. Matched as a contains against the RDN value of the people in this realm’s ou=users. |
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
more |
boolean | ||
people |
list | At most ten. | |
people[].cn |
string | ||
people[].dn |
string | ||
people[].uid |
string | ||
query |
string |
400: Fewer than three characters (STS-PORTAL-0620).
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
429: Too many searches in the window (STS-PORTAL-0621, or the rate limiter’s own code).
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
503: The directory could not answer (STS-PORTAL-0622).
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/device
getDeviceRequest
The device request a user code brings up
RFC 8628 section 3.3. With no user_code, only whether the flow is on. With one, the waiting request — the client and the scopes — so that you see what you would approve before approving it (section 5.4). Five codes that match nothing lock the sign-on session out for ten minutes (section 5.1).
The door of the portal’s GET /portal/device.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
user_code |
query | string | The code the device shows; brings up its request. | |
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
enabled |
boolean | ||
record |
object | ||
record.clientId |
string | ||
record.clientName |
string | ||
record.expiresAt |
string or number, or null | ||
record.scope |
string | ||
record.userCode |
string | ||
typed |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
404: No device is waiting with that code.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.enabled |
boolean | ||
view.record |
object | ||
view.record.clientId |
string | ||
view.record.clientName |
string | ||
view.record.expiresAt |
string or number, or null | ||
view.record.scope |
string | ||
view.record.userCode |
string | ||
view.typed |
string |
429: Too many codes that matched nothing.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.enabled |
boolean | ||
view.record |
object | ||
view.record.clientId |
string | ||
view.record.clientName |
string | ||
view.record.expiresAt |
string or number, or null | ||
view.record.scope |
string | ||
view.record.userCode |
string | ||
view.typed |
string |
POST /account-api/device
answerDeviceRequest
Approves or denies a device sign-in
An approval issues the device tokens for you, on the sign-on session this token was issued on, which ends them when it ends.
The door of the portal’s POST /portal/device.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
action |
one of approve, deny |
yes | approve signs you in on the device; deny refuses it. |
user_code |
string | yes | The code the device shows. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.enabled |
boolean | ||
view.record |
object | ||
view.record.clientId |
string | ||
view.record.clientName |
string | ||
view.record.expiresAt |
string or number, or null | ||
view.record.scope |
string | ||
view.record.userCode |
string | ||
view.typed |
string |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
429: Too many codes that matched nothing.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.enabled |
boolean | ||
view.record |
object | ||
view.record.clientId |
string | ||
view.record.clientName |
string | ||
view.record.expiresAt |
string or number, or null | ||
view.record.scope |
string | ||
view.record.userCode |
string | ||
view.typed |
string |
GET /account-api/devices
getDevices
Your devices, and how to register one
Each device you own: its applications, whether its Native SSO secret is live, its keys and their attestation, how it was registered and when it was last used. Then the key-proof step (proof: the challenge held, with the audience and proofTyp a proof names), the passkeys built into a device that can be linked (link) or the link ceremony armed (linking), and whether this browser may be remembered.
The door of the portal’s GET /portal/devices.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
audience |
string | ||
devices |
list | ||
devices[].applications |
list | ||
devices[].applications[] |
string | ||
devices[].attestation |
string | ||
devices[].enrolment |
string | ||
devices[].id |
string | ||
devices[].keys |
list | ||
devices[].keys[].kind |
string | ||
devices[].keys[].level |
string | ||
devices[].label |
string | ||
devices[].lastUsed |
string or number, or null | ||
devices[].nativeSso |
boolean | ||
devices[].sessionLive |
boolean | ||
link |
object | ||
link.enrolled |
integer | ||
link.keys |
list | ||
link.keys[].credentialId |
string | ||
link.keys[].name |
string | ||
link.keys[].trusted |
boolean | ||
link.roaming |
list | ||
link.roaming[] |
string | ||
linking |
object | ||
linking.allow |
string | ||
linking.challenge |
string | ||
linking.options |
object | ||
linking.options.hints |
list | ||
linking.options.hints[] |
string | ||
linking.options.rpId |
string | ||
linking.options.timeout |
number | ||
linking.options.userVerification |
string | ||
linking.rpId |
string | ||
linking.user |
string | ||
platforms |
list | ||
platforms[] |
string | ||
proof |
object | ||
proof.challenge |
string | ||
proof.expiresAt |
string or number, or null | ||
proofTyp |
string | ||
remember |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/devices
actOnDevices
Registers, links, remembers or removes a device
challenge then prove registers a device by a key proof (or an App Attest object); link-begin then link-finish links a passkey built into it by a fresh assertion; remember-browser remembers this browser (a cookie on the answer); remove removes a device and its Native SSO secret. A refusal carries the page’s view.
The door of the portal’s POST /portal/devices.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
action |
``, or one of remove, challenge, prove, cancel-proof, link-begin, link-finish, link-cancel, remember-browser |
What to do; remove where none is named. |
|
app_attest_key_id |
string | prove: an App Attest key id, beside its object. |
|
app_attest_object |
string | prove: an App Attest attestation object. |
|
challenge |
string | prove, link-finish: the challenge being answered. |
|
credential |
string | link-finish: the WebAuthn assertion, as JSON. |
|
credential_id |
string | link-begin: the passkey (built into this device) to link. |
|
device |
string | prove, link-begin: an existing device to add the key to; a new device where empty. |
|
id |
string | remove: the device. |
|
key_label |
string | prove: the key’s name. |
|
label |
string | The device’s name. | |
model |
string | The device’s model. | |
os |
string | The device’s operating system. | |
platform |
string | The device’s platform. | |
proof |
string | prove: the device-key-proof+jwt JWS. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.audience |
string | ||
view.devices |
list | ||
view.devices[].applications |
list | ||
view.devices[].applications[] |
string | ||
view.devices[].attestation |
string | ||
view.devices[].enrolment |
string | ||
view.devices[].id |
string | ||
view.devices[].keys |
list | ||
view.devices[].keys[].kind |
string | ||
view.devices[].keys[].level |
string | ||
view.devices[].label |
string | ||
view.devices[].lastUsed |
string or number, or null | ||
view.devices[].nativeSso |
boolean | ||
view.devices[].sessionLive |
boolean | ||
view.link |
object | ||
view.link.enrolled |
integer | ||
view.link.keys |
list | ||
view.link.keys[].credentialId |
string | ||
view.link.keys[].name |
string | ||
view.link.keys[].trusted |
boolean | ||
view.link.roaming |
list | ||
view.link.roaming[] |
string | ||
view.linking |
object | ||
view.linking.allow |
string | ||
view.linking.challenge |
string | ||
view.linking.options |
object | ||
view.linking.options.hints |
list | ||
view.linking.options.hints[] |
string | ||
view.linking.options.rpId |
string | ||
view.linking.options.timeout |
number | ||
view.linking.options.userVerification |
string | ||
view.linking.rpId |
string | ||
view.linking.user |
string | ||
view.platforms |
list | ||
view.platforms[] |
string | ||
view.proof |
object | ||
view.proof.challenge |
string | ||
view.proof.expiresAt |
string or number, or null | ||
view.proofTyp |
string | ||
view.remember |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/devices/challenge
deviceChallenge
A key-proof challenge, for a device app
Issues a challenge bound to the sign-on session this token was issued on: { ok, challenge, audience, typ, expires_at, proof_endpoint }. The device signs a JWS of type typ over { nonce: challenge, aud: audience, iat } with the key it registers, and posts it to proof_endpoint.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
purpose |
one of key |
What the challenge is for; key, the only one. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
audience |
string | ||
challenge |
string | ||
expires_at |
string or number, or null | ||
ok |
boolean | ||
proof_endpoint |
string | ||
typ |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/devices/proof
deviceProof
A device app’s key proof
Answers a challenge with a key proof or an Apple App Attest object, registering the device (or adding the key to device_id). Answers 201 { ok, device, key }.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
app_attest |
object | Or an Apple App Attest key and object. | |
app_attest.attestation |
string | yes | |
app_attest.key_id |
string | yes | |
challenge |
string | yes | The challenge devices/challenge issued. |
device_id |
string | An existing device of yours to add the key to. | |
key_label |
string | ||
label |
string | ||
model |
string | ||
os |
string | ||
platform |
string | ||
proof |
string | The device-key-proof+jwt JWS. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
device |
object | ||
device.applications |
list | ||
device.applications[] |
string | ||
device.attestation |
object | ||
device.attestation.format |
string | ||
device.attestation.keyId |
string | ||
device.attestation.level |
string | ||
device.attestation.summary |
string | ||
device.compliance |
string | ||
device.complianceChange |
object | ||
device.complianceChange.actor |
string | ||
device.complianceChange.at |
string | ||
device.complianceChange.previous |
string | ||
device.complianceChange.reason |
string | ||
device.complianceChange.source |
string | ||
device.complianceChange.status |
string | ||
device.created |
string | ||
device.dn |
string | ||
device.enrolment |
object | ||
device.enrolment.actor |
string | ||
device.enrolment.at |
string | ||
device.enrolment.method |
string | ||
device.id |
string | ||
device.keyKinds |
list | ||
device.keyKinds[] |
string | ||
device.keys |
list | ||
device.keys[].added |
string | ||
device.keys[].addedBy |
string | ||
device.keys[].attestation |
object | ||
device.keys[].attestation.chainSerials |
list | ||
device.keys[].attestation.chainSerials[] |
string | ||
device.keys[].attestation.format |
string | ||
device.keys[].attestation.freshness |
object | ||
device.keys[].attestation.freshness.detail |
string | ||
device.keys[].attestation.freshness.status |
string | ||
device.keys[].attestation.level |
string | ||
device.keys[].attestation.revocation |
object | ||
device.keys[].attestation.revocation.chainSerials |
list | ||
device.keys[].attestation.revocation.chainSerials[] |
string | ||
device.keys[].attestation.revocation.checkedAt |
string | ||
device.keys[].attestation.revocation.listVersion |
string | ||
device.keys[].attestation.revocation.reason |
string | ||
device.keys[].attestation.revocation.serial |
string | ||
device.keys[].attestation.revocation.status |
string | ||
device.keys[].attestation.revocation.why |
string | ||
device.keys[].attestation.summary |
string | ||
device.keys[].attestation.verifiedAt |
string | ||
device.keys[].id |
string | ||
device.keys[].kind |
string | ||
device.keys[].label |
string | ||
device.keys[].material |
object | ||
device.keys[].material.aaguid |
string | ||
device.keys[].material.attachment |
string | ||
device.keys[].material.certificate |
string | ||
device.keys[].material.credentialId |
string | ||
device.keys[].material.issuer |
string | ||
device.keys[].material.jwk |
any JSON | A public JWK as the device presented it (RFC 7517): its members depend on its key type. A public JWK as the device presented it (RFC 7517): its members depend on its key type. | |
device.keys[].material.notAfter |
string | ||
device.keys[].material.serial |
string | ||
device.keys[].material.subject |
string | ||
device.keys[].proof |
string | ||
device.keys[].thumbprint |
string | ||
device.label |
string | ||
device.lastUsed |
string | ||
device.model |
string | ||
device.nativeSso |
boolean | ||
device.os |
string | ||
device.owner |
string | ||
device.ownerKind |
string | ||
device.platform |
string | ||
device.rememberedBrowser |
object | ||
device.rememberedBrowser.browser |
string | ||
device.rememberedBrowser.generation |
number | ||
device.rememberedBrowser.issuedAt |
string | ||
device.rememberedBrowser.secondFactorAt |
string | ||
device.riskChange |
object | ||
device.riskChange.actor |
string | ||
device.riskChange.at |
string | ||
device.riskChange.beforeCompromise |
string | ||
device.riskChange.level |
string | ||
device.riskChange.previous |
string | ||
device.riskChange.reason |
string | ||
device.riskChange.source |
string | ||
device.riskLevel |
string | ||
device.sessionLive |
boolean | ||
device.status |
string | ||
device.statusChange |
object | ||
device.statusChange.actor |
string | ||
device.statusChange.at |
string | ||
device.statusChange.previous |
string | ||
device.statusChange.reason |
string | ||
device.statusChange.source |
string | ||
device.statusChange.status |
string | ||
key |
object | ||
key.added |
string | ||
key.addedBy |
string | ||
key.attestation |
object | ||
key.attestation.chainSerials |
list | ||
key.attestation.chainSerials[] |
string | ||
key.attestation.format |
string | ||
key.attestation.freshness |
object | ||
key.attestation.freshness.detail |
string | ||
key.attestation.freshness.status |
string | ||
key.attestation.level |
string | ||
key.attestation.revocation |
object | ||
key.attestation.revocation.chainSerials |
list | ||
key.attestation.revocation.chainSerials[] |
string | ||
key.attestation.revocation.checkedAt |
string | ||
key.attestation.revocation.listVersion |
string | ||
key.attestation.revocation.reason |
string | ||
key.attestation.revocation.serial |
string | ||
key.attestation.revocation.status |
string | ||
key.attestation.revocation.why |
string | ||
key.attestation.summary |
string | ||
key.attestation.verifiedAt |
string | ||
key.id |
string | ||
key.kind |
string | ||
key.label |
string | ||
key.material |
object | ||
key.material.aaguid |
string | ||
key.material.attachment |
string | ||
key.material.certificate |
string | ||
key.material.credentialId |
string | ||
key.material.issuer |
string | ||
key.material.jwk |
any JSON | A public JWK as the device presented it (RFC 7517): its members depend on its key type. A public JWK as the device presented it (RFC 7517): its members depend on its key type. | |
key.material.notAfter |
string | ||
key.material.serial |
string | ||
key.material.subject |
string | ||
key.proof |
string | ||
key.thumbprint |
string | ||
ok |
boolean |
201: The device is registered: { ok, device, key }.
| Member | Type | Required | What it is |
|---|---|---|---|
device |
object | ||
device.applications |
list | ||
device.applications[] |
string | ||
device.attestation |
object | ||
device.attestation.format |
string | ||
device.attestation.keyId |
string | ||
device.attestation.level |
string | ||
device.attestation.summary |
string | ||
device.compliance |
string | ||
device.complianceChange |
object | ||
device.complianceChange.actor |
string | ||
device.complianceChange.at |
string | ||
device.complianceChange.previous |
string | ||
device.complianceChange.reason |
string | ||
device.complianceChange.source |
string | ||
device.complianceChange.status |
string | ||
device.created |
string | ||
device.dn |
string | ||
device.enrolment |
object | ||
device.enrolment.actor |
string | ||
device.enrolment.at |
string | ||
device.enrolment.method |
string | ||
device.id |
string | ||
device.keyKinds |
list | ||
device.keyKinds[] |
string | ||
device.keys |
list | ||
device.keys[].added |
string | ||
device.keys[].addedBy |
string | ||
device.keys[].attestation |
object | ||
device.keys[].attestation.chainSerials |
list | ||
device.keys[].attestation.chainSerials[] |
string | ||
device.keys[].attestation.format |
string | ||
device.keys[].attestation.freshness |
object | ||
device.keys[].attestation.freshness.detail |
string | ||
device.keys[].attestation.freshness.status |
string | ||
device.keys[].attestation.level |
string | ||
device.keys[].attestation.revocation |
object | ||
device.keys[].attestation.revocation.chainSerials |
list | ||
device.keys[].attestation.revocation.chainSerials[] |
string | ||
device.keys[].attestation.revocation.checkedAt |
string | ||
device.keys[].attestation.revocation.listVersion |
string | ||
device.keys[].attestation.revocation.reason |
string | ||
device.keys[].attestation.revocation.serial |
string | ||
device.keys[].attestation.revocation.status |
string | ||
device.keys[].attestation.revocation.why |
string | ||
device.keys[].attestation.summary |
string | ||
device.keys[].attestation.verifiedAt |
string | ||
device.keys[].id |
string | ||
device.keys[].kind |
string | ||
device.keys[].label |
string | ||
device.keys[].material |
object | ||
device.keys[].material.aaguid |
string | ||
device.keys[].material.attachment |
string | ||
device.keys[].material.certificate |
string | ||
device.keys[].material.credentialId |
string | ||
device.keys[].material.issuer |
string | ||
device.keys[].material.jwk |
any JSON | A public JWK as the device presented it (RFC 7517): its members depend on its key type. A public JWK as the device presented it (RFC 7517): its members depend on its key type. | |
device.keys[].material.notAfter |
string | ||
device.keys[].material.serial |
string | ||
device.keys[].material.subject |
string | ||
device.keys[].proof |
string | ||
device.keys[].thumbprint |
string | ||
device.label |
string | ||
device.lastUsed |
string | ||
device.model |
string | ||
device.nativeSso |
boolean | ||
device.os |
string | ||
device.owner |
string | ||
device.ownerKind |
string | ||
device.platform |
string | ||
device.rememberedBrowser |
object | ||
device.rememberedBrowser.browser |
string | ||
device.rememberedBrowser.generation |
number | ||
device.rememberedBrowser.issuedAt |
string | ||
device.rememberedBrowser.secondFactorAt |
string | ||
device.riskChange |
object | ||
device.riskChange.actor |
string | ||
device.riskChange.at |
string | ||
device.riskChange.beforeCompromise |
string | ||
device.riskChange.level |
string | ||
device.riskChange.previous |
string | ||
device.riskChange.reason |
string | ||
device.riskChange.source |
string | ||
device.riskLevel |
string | ||
device.sessionLive |
boolean | ||
device.status |
string | ||
device.statusChange |
object | ||
device.statusChange.actor |
string | ||
device.statusChange.at |
string | ||
device.statusChange.previous |
string | ||
device.statusChange.reason |
string | ||
device.statusChange.source |
string | ||
device.statusChange.status |
string | ||
key |
object | ||
key.added |
string | ||
key.addedBy |
string | ||
key.attestation |
object | ||
key.attestation.chainSerials |
list | ||
key.attestation.chainSerials[] |
string | ||
key.attestation.format |
string | ||
key.attestation.freshness |
object | ||
key.attestation.freshness.detail |
string | ||
key.attestation.freshness.status |
string | ||
key.attestation.level |
string | ||
key.attestation.revocation |
object | ||
key.attestation.revocation.chainSerials |
list | ||
key.attestation.revocation.chainSerials[] |
string | ||
key.attestation.revocation.checkedAt |
string | ||
key.attestation.revocation.listVersion |
string | ||
key.attestation.revocation.reason |
string | ||
key.attestation.revocation.serial |
string | ||
key.attestation.revocation.status |
string | ||
key.attestation.revocation.why |
string | ||
key.attestation.summary |
string | ||
key.attestation.verifiedAt |
string | ||
key.id |
string | ||
key.kind |
string | ||
key.label |
string | ||
key.material |
object | ||
key.material.aaguid |
string | ||
key.material.attachment |
string | ||
key.material.certificate |
string | ||
key.material.credentialId |
string | ||
key.material.issuer |
string | ||
key.material.jwk |
any JSON | A public JWK as the device presented it (RFC 7517): its members depend on its key type. A public JWK as the device presented it (RFC 7517): its members depend on its key type. | |
key.material.notAfter |
string | ||
key.material.serial |
string | ||
key.material.subject |
string | ||
key.proof |
string | ||
key.thumbprint |
string | ||
ok |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/email
getEmail
Your email address, its messages, and what was sent
address and whether it is verified, a change waiting for its link (changing), whether mail can be sent (available), the message categories (only notification is optional; sent says whether you are sent it), and one page of the messages sent to you, newest first — never their bodies — moved by sentPage and described by sentPaging.
The door of the portal’s GET /portal/email.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
sentPage |
query | Which page of sent, newest first. Clamped to the last. |
||
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
address |
string | ||
available |
boolean | ||
categories |
list | ||
categories[].id |
string | ||
categories[].label |
string | ||
categories[].optional |
boolean | ||
categories[].sent |
boolean | ||
categories[].what |
string | ||
changing |
string | ||
sent |
list | ||
sent[].queuedAt |
string or number, or null | ||
sent[].state |
string, or null | ||
sent[].subject |
string, or null | ||
sent[].to |
list, or string, or null | ||
sent[].to[] |
string | ||
sentPaging |
object | ||
sentPaging.page |
integer | ||
sentPaging.pages |
integer | ||
sentPaging.per |
integer | ||
sentPaging.total |
integer | ||
verified |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/email
postEmail
Verifies your address, changes it, or saves your choices
verify sends a verification link to your address; change sends one to a new address, which takes effect only when that link is used; preferences saves whether you are sent notifications. The two that send mail are rate limited. A refusal carries the page’s view.
The door of the portal’s POST /portal/email.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
action |
``, or one of verify, preferences, change |
verify sends a link to the address on your entry; change sends one to address; preferences saves notification. |
|
address |
string | The new address, for change. |
|
notification |
``, or one of 0, 1, true, false, on, off, yes, no |
on to be sent notifications, for preferences. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean | ||
stepUp |
object | ||
stepUp.acrValues |
string | ||
stepUp.maxAge |
number | ||
stepUp.prompt |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.address |
string | ||
view.available |
boolean | ||
view.categories |
list | ||
view.categories[].id |
string | ||
view.categories[].label |
string | ||
view.categories[].optional |
boolean | ||
view.categories[].sent |
boolean | ||
view.categories[].what |
string | ||
view.changing |
string | ||
view.sent |
list | ||
view.sent[].queuedAt |
string or number, or null | ||
view.sent[].state |
string, or null | ||
view.sent[].subject |
string, or null | ||
view.sent[].to |
list, or string, or null | ||
view.sent[].to[] |
string | ||
view.sentPaging |
object | ||
view.sentPaging.page |
integer | ||
view.sentPaging.pages |
integer | ||
view.sentPaging.per |
integer | ||
view.sentPaging.total |
integer | ||
view.verified |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
429: Too many attempts; try again later.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.address |
string | ||
view.available |
boolean | ||
view.categories |
list | ||
view.categories[].id |
string | ||
view.categories[].label |
string | ||
view.categories[].optional |
boolean | ||
view.categories[].sent |
boolean | ||
view.categories[].what |
string | ||
view.changing |
string | ||
view.sent |
list | ||
view.sent[].queuedAt |
string or number, or null | ||
view.sent[].state |
string, or null | ||
view.sent[].subject |
string, or null | ||
view.sent[].to |
list, or string, or null | ||
view.sent[].to[] |
string | ||
view.sentPaging |
object | ||
view.sentPaging.page |
integer | ||
view.sentPaging.pages |
integer | ||
view.sentPaging.per |
integer | ||
view.sentPaging.total |
integer | ||
view.verified |
boolean |
GET /account-api/forgot-password
getForgotPassword
Whether a forgotten password can be reset here, and how
threeFields when a recovery code is asked for beside the account and its address. 404 where self-service reset is not offered (the setting off, no transport, or development mode).
The door of the portal’s GET /portal/forgot-password.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
notOffered |
string | ||
note |
string | ||
threeFields |
boolean | ||
tooMany |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
404: Not offered here; view.notOffered says so.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.notOffered |
string | ||
view.note |
string | ||
view.threeFields |
boolean | ||
view.tooMany |
string |
POST /account-api/forgot-password
requestPasswordReset
Asks for a password reset link
Answers ONE SENTENCE whatever happened (view.note), before the work is done, so neither its words nor its timing say whether the account exists; the link, if any, is mailed to the address on the account. Rate limited per account and address.
The door of the portal’s POST /portal/forgot-password.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
account |
string | Your username, or the address on your account. | |
address |
string | The address on your account, where a recovery code is asked for. | |
code |
string | One of your recovery codes, where one is asked for. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean | ||
view |
object | ||
view.notOffered |
string | ||
view.note |
string | ||
view.threeFields |
boolean | ||
view.tooMany |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
404: Not offered here.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.notOffered |
string | ||
view.note |
string | ||
view.threeFields |
boolean | ||
view.tooMany |
string |
429: Too many attempts; view.tooMany says so.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.notOffered |
string | ||
view.note |
string | ||
view.threeFields |
boolean | ||
view.tooMany |
string |
GET /account-api/gnap
getGnapGrants
The GNAP grants you gave
One page (paging) of rows: each grant whose resource owner you are — the client, its state or why it ended, its access rights (RFC 9635 objects or references), the tokens issued under it, when it was granted and until when, and whether you may revoke it. The same view an administrator’s user page draws. Under cells, cells says when another cell may hold more.
The door of the portal’s GET /portal/gnap.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
page |
query | |||
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
cells |
object | ||
cells.cell |
string | ||
cells.complete |
boolean | ||
cells.multiCell |
boolean | ||
cells.note |
string | ||
paging |
object | ||
paging.firstRow |
integer | ||
paging.lastRow |
integer | ||
paging.noun |
string, or null | ||
paging.page |
integer | ||
paging.pages |
integer | ||
paging.param |
string, or null | ||
paging.perPage |
integer | ||
paging.total |
integer | ||
rows |
list | ||
rows[].approvedBy |
string | ||
rows[].authorizationServer |
string, or null | ||
rows[].client |
string, or null | ||
rows[].clientName |
string, or null | ||
rows[].createdAt |
string or number, or null | ||
rows[].derivedFrom |
string, or null | ||
rows[].finalization |
object | ||
rows[].finalization.at |
number | ||
rows[].finalization.note |
string | ||
rows[].finalization.reason |
string | ||
rows[].grantExpiresAt |
string or number, or null | ||
rows[].id |
string | ||
rows[].revocable |
boolean | ||
rows[].rights |
list | ||
rows[].rights[] |
any JSON | An RFC 9635 section 8 access right as the client asked for it: a reference string, or an object whose members the client and the resource server define. An RFC 9635 section 8 access right as the client asked for it: a reference string, or an object whose members the client and the resource server define. | |
rows[].rightsAre |
string | ||
rows[].state |
string | ||
rows[].subjectReleasedAt |
string or number, or null | ||
rows[].tokens |
list | ||
rows[].tokens[].access |
list | ||
rows[].tokens[].access[] |
any JSON | An RFC 9635 section 8 access right as the client asked for it: a reference string, or an object whose members the client and the resource server define. An RFC 9635 section 8 access right as the client asked for it: a reference string, or an object whose members the client and the resource server define. | |
rows[].tokens[].bearer |
boolean | ||
rows[].tokens[].expiresAt |
string or number, or null | ||
rows[].tokens[].format |
string, or null | ||
rows[].tokens[].issuedAt |
string or number, or null | ||
rows[].tokens[].jti |
string | ||
rows[].tokens[].label |
string, or null | ||
rows[].tokens[].revokedWhy |
string, or null | ||
rows[].tokens[].state |
string | ||
rows[].updatedAt |
string or number, or null | ||
total |
integer | ||
user |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/gnap
revokeGnapGrant
Revokes a GNAP grant you gave
The client’s own RFC 9635 section 5.4 act, performed for you: every token issued under the grant stops working, the grant is finalized as revoked, and CAEP session-revoked is sent. A grant that is not yours is refused.
The door of the portal’s POST /portal/gnap.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
grant |
string | yes | The grant to end, from the list. |
page |
``, or integer | The page of the list the form was on. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.cells |
object | ||
view.cells.cell |
string | ||
view.cells.complete |
boolean | ||
view.cells.multiCell |
boolean | ||
view.cells.note |
string | ||
view.paging |
object | ||
view.paging.firstRow |
integer | ||
view.paging.lastRow |
integer | ||
view.paging.noun |
string, or null | ||
view.paging.page |
integer | ||
view.paging.pages |
integer | ||
view.paging.param |
string, or null | ||
view.paging.perPage |
integer | ||
view.paging.total |
integer | ||
view.rows |
list | ||
view.rows[].approvedBy |
string | ||
view.rows[].authorizationServer |
string, or null | ||
view.rows[].client |
string, or null | ||
view.rows[].clientName |
string, or null | ||
view.rows[].createdAt |
string or number, or null | ||
view.rows[].derivedFrom |
string, or null | ||
view.rows[].finalization |
object | ||
view.rows[].finalization.at |
number | ||
view.rows[].finalization.note |
string | ||
view.rows[].finalization.reason |
string | ||
view.rows[].grantExpiresAt |
string or number, or null | ||
view.rows[].id |
string | ||
view.rows[].revocable |
boolean | ||
view.rows[].rights |
list | ||
view.rows[].rights[] |
any JSON | An RFC 9635 section 8 access right as the client asked for it: a reference string, or an object whose members the client and the resource server define. An RFC 9635 section 8 access right as the client asked for it: a reference string, or an object whose members the client and the resource server define. | |
view.rows[].rightsAre |
string | ||
view.rows[].state |
string | ||
view.rows[].subjectReleasedAt |
string or number, or null | ||
view.rows[].tokens |
list | ||
view.rows[].tokens[].access |
list | ||
view.rows[].tokens[].access[] |
any JSON | An RFC 9635 section 8 access right as the client asked for it: a reference string, or an object whose members the client and the resource server define. An RFC 9635 section 8 access right as the client asked for it: a reference string, or an object whose members the client and the resource server define. | |
view.rows[].tokens[].bearer |
boolean | ||
view.rows[].tokens[].expiresAt |
string or number, or null | ||
view.rows[].tokens[].format |
string, or null | ||
view.rows[].tokens[].issuedAt |
string or number, or null | ||
view.rows[].tokens[].jti |
string | ||
view.rows[].tokens[].label |
string, or null | ||
view.rows[].tokens[].revokedWhy |
string, or null | ||
view.rows[].tokens[].state |
string | ||
view.rows[].updatedAt |
string or number, or null | ||
view.total |
integer | ||
view.user |
string |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/kerberos
getKerberos
Your Kerberos principal and its keys
Whether this realm has a KDC and you are a principal in it, the principal, and in product mode the keys’ kvno and encryption types; disabled for an account no keytab is made for.
The door of the portal’s GET /portal/kerberos.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
disabled |
boolean | ||
kdc |
boolean | ||
keys |
object | ||
keys.current |
boolean | ||
keys.etypes |
list | ||
keys.etypes[].name |
string | ||
keys.kvno |
number, or null | ||
made |
object | ||
made.etypes |
list | ||
made.etypes[] |
string | ||
made.keytab |
string | ||
made.keytabFilename |
string | ||
made.kvno |
number, or null | ||
made.principal |
string | ||
made.source |
string | ||
person |
boolean | ||
principal |
string | ||
productKdc |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/kerberos
makeKeytab
Makes you a keytab from your own password
Re-proves the password (rate limited in the budget the password change shares), derives the keys from it and checks them against the KDC’s. The keytab is in the answer’s view.made, base64, ONCE: nothing can show it again. Nothing about the account changes.
The door of the portal’s POST /portal/kerberos.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
action |
``, or one of keytab |
keytab, the one thing this page does. |
|
current |
string | Your password: the keytab is derived from it, and it re-proves you. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean | ||
view |
object | ||
view.disabled |
boolean | ||
view.kdc |
boolean | ||
view.keys |
object | ||
view.keys.current |
boolean | ||
view.keys.etypes |
list | ||
view.keys.etypes[].name |
string | ||
view.keys.kvno |
number, or null | ||
view.made |
object | ||
view.made.etypes |
list | ||
view.made.etypes[] |
string | ||
view.made.keytab |
string | ||
view.made.keytabFilename |
string | ||
view.made.kvno |
number, or null | ||
view.made.principal |
string | ||
view.made.source |
string | ||
view.person |
boolean | ||
view.principal |
string | ||
view.productKdc |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.disabled |
boolean | ||
view.kdc |
boolean | ||
view.keys |
object | ||
view.keys.current |
boolean | ||
view.keys.etypes |
list | ||
view.keys.etypes[].name |
string | ||
view.keys.kvno |
number, or null | ||
view.made |
object | ||
view.made.etypes |
list | ||
view.made.etypes[] |
string | ||
view.made.keytab |
string | ||
view.made.keytabFilename |
string | ||
view.made.kvno |
number, or null | ||
view.made.principal |
string | ||
view.made.source |
string | ||
view.person |
boolean | ||
view.principal |
string | ||
view.productKdc |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
429: Too many attempts; try again later.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.disabled |
boolean | ||
view.kdc |
boolean | ||
view.keys |
object | ||
view.keys.current |
boolean | ||
view.keys.etypes |
list | ||
view.keys.etypes[].name |
string | ||
view.keys.kvno |
number, or null | ||
view.made |
object | ||
view.made.etypes |
list | ||
view.made.etypes[] |
string | ||
view.made.keytab |
string | ||
view.made.keytabFilename |
string | ||
view.made.kvno |
number, or null | ||
view.made.principal |
string | ||
view.made.source |
string | ||
view.person |
boolean | ||
view.principal |
string | ||
view.productKdc |
boolean |
GET /account-api/keys
getKeys
Your passkeys, and adding one
Each passkey you hold (keys), grouped device or security-key, with its name, provider, dates, algorithm, what its attestation proved and whether the realm’s passkey policy refuses it at sign-in. enrol says whether you may add one and, while a registration is waiting, the ceremony to run (enrol.pending) and the lanes a passkey may be created in (enrol.lanes, #643). signals is the WebAuthn Signal API’s data, one entry per lane whose user handle you hold.
The door of the portal’s GET /portal/keys.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
enrol |
object | ||
enrol.allowed |
boolean | ||
enrol.atCap |
boolean | ||
enrol.count |
integer | ||
enrol.enabled |
boolean | ||
enrol.kinds |
list | ||
enrol.kinds[] |
string | ||
enrol.lanes |
list | ||
enrol.lanes[] |
string | ||
enrol.pending |
object | ||
enrol.pending.challenge |
string | ||
enrol.pending.display |
string | ||
enrol.pending.exclude |
list | ||
enrol.pending.exclude[] |
string | ||
enrol.pending.fallback |
object | ||
enrol.pending.fallback.asksPostQuantum |
boolean | ||
enrol.pending.fallback.classical |
boolean | ||
enrol.pending.fallback.retrying |
boolean | ||
enrol.pending.id |
string | ||
enrol.pending.kind |
string | ||
enrol.pending.lane |
string | ||
enrol.pending.options |
object | ||
enrol.pending.options.algorithms |
list | ||
enrol.pending.options.algorithms[] |
integer | ||
enrol.pending.options.attestation |
string | ||
enrol.pending.options.authenticatorSelection |
object | ||
enrol.pending.options.authenticatorSelection.authenticatorAttachment |
string | ||
enrol.pending.options.authenticatorSelection.requireResidentKey |
boolean | ||
enrol.pending.options.authenticatorSelection.residentKey |
string | ||
enrol.pending.options.authenticatorSelection.userVerification |
string | ||
enrol.pending.options.credProps |
boolean | ||
enrol.pending.options.hints |
list | ||
enrol.pending.options.hints[] |
string | ||
enrol.pending.options.minPinLength |
boolean | ||
enrol.pending.options.rp |
object | ||
enrol.pending.options.rp.id |
string | ||
enrol.pending.options.rp.name |
string | ||
enrol.pending.options.timeout |
number | ||
enrol.pending.rpId |
string | ||
enrol.pending.user |
string | ||
enrol.pending.userHandle |
string | ||
keys |
list | ||
keys[].aaguid |
string | ||
keys[].algorithm |
object | ||
keys[].algorithm.insecure |
boolean | ||
keys[].algorithm.postQuantum |
boolean | ||
keys[].algorithm.text |
string | ||
keys[].attestation |
object | ||
keys[].attestation.androidStatus |
string | ||
keys[].attestation.deviceSerial |
string | ||
keys[].attestation.model |
string | ||
keys[].attestation.trusted |
boolean | ||
keys[].attestation.type |
string | ||
keys[].attestation.verified |
boolean | ||
keys[].attestationRefused |
string | ||
keys[].backupEligible |
boolean, or null | ||
keys[].backupState |
boolean | ||
keys[].credentialId |
string | ||
keys[].enrolledAt |
string or number, or null | ||
keys[].group |
string | ||
keys[].kind |
string | ||
keys[].lane |
string | ||
keys[].lastUsedAt |
string or number, or null | ||
keys[].name |
string | ||
keys[].pinRefused |
string | ||
keys[].possiblyReplaced |
object | ||
keys[].possiblyReplaced.at |
number | ||
keys[].postQuantumRefused |
boolean | ||
keys[].provider |
string | ||
keys[].syncedRefused |
boolean | ||
keys[].transports |
list | ||
keys[].transports[] |
string | ||
keys[].upgrade |
object | ||
keys[].upgrade.mode |
string | ||
keys[].upgrade.previousAlgorithm |
string | ||
keys[].upgrade.previousCredentialId |
string | ||
keys[].upgrade.upgradedAt |
number | ||
keys[].upgrade.upgradedTo |
string | ||
keys[].withoutUsername |
string | ||
mfaRequired |
boolean | ||
password |
boolean | ||
signals |
list | ||
signals[].accepted |
list | ||
signals[].accepted[] |
string | ||
signals[].display |
string | ||
signals[].lane |
string | ||
signals[].name |
string | ||
signals[].rpId |
string | ||
signals[].userId |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/keys
enrolKey
Begins, finishes or cancels adding a passkey
begin mints a challenge and holds it (the policy and the lane, #643, checked at the door; algorithms: classical, #944, the classical retry, refused where the realm forbids a classical passkey); finish verifies the browser’s registration with the sign-in screen’s address rules and answers go naming the new passkey; cancel drops the waiting one. A refusal carries the page’s view, except a browser error reported with its own capabilities property while the classical retry is offered (#961): that enrolment stays and the answer carries no view. role is accepted and ignored since #1135: a passkey carries no role, and the realm decides how every key may be used. enrol.allowed says whether the realm accepts a new passkey for any use.
The door of the portal’s POST /portal/keys.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
action |
``, or one of begin, finish, cancel |
begin mints a challenge, finish answers it, cancel drops it. |
|
algorithms |
``, or one of classical |
begin: classical retries with the classical algorithms only, where enrol.pending.fallback.classical says the realm allows it. |
|
credential |
string | finish: the browser’s ceremony result, as JSON. |
|
enrolment_id |
``, or string | finish: the pending enrolment the ceremony answers. |
|
kind |
``, or one of passkey, security-key |
begin: which call to action was pressed. |
|
lane |
``, or one of classical, pqc |
begin: classical (the default) or pqc, where the realm offers a post-quantum passkey beside a classical one. |
|
role |
``, or one of primary, mfa |
Ignored since #1135: a passkey carries no role. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean | ||
stepUp |
object | ||
stepUp.acrValues |
string | ||
stepUp.maxAge |
number | ||
stepUp.prompt |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.enrol |
object | ||
view.enrol.allowed |
boolean | ||
view.enrol.atCap |
boolean | ||
view.enrol.count |
integer | ||
view.enrol.enabled |
boolean | ||
view.enrol.kinds |
list | ||
view.enrol.kinds[] |
string | ||
view.enrol.lanes |
list | ||
view.enrol.lanes[] |
string | ||
view.enrol.pending |
object | ||
view.enrol.pending.challenge |
string | ||
view.enrol.pending.display |
string | ||
view.enrol.pending.exclude |
list | ||
view.enrol.pending.exclude[] |
string | ||
view.enrol.pending.fallback |
object | ||
view.enrol.pending.fallback.asksPostQuantum |
boolean | ||
view.enrol.pending.fallback.classical |
boolean | ||
view.enrol.pending.fallback.retrying |
boolean | ||
view.enrol.pending.id |
string | ||
view.enrol.pending.kind |
string | ||
view.enrol.pending.lane |
string | ||
view.enrol.pending.options |
object | ||
view.enrol.pending.options.algorithms |
list | ||
view.enrol.pending.options.algorithms[] |
integer | ||
view.enrol.pending.options.attestation |
string | ||
view.enrol.pending.options.authenticatorSelection |
object | ||
view.enrol.pending.options.authenticatorSelection.authenticatorAttachment |
string | ||
view.enrol.pending.options.authenticatorSelection.requireResidentKey |
boolean | ||
view.enrol.pending.options.authenticatorSelection.residentKey |
string | ||
view.enrol.pending.options.authenticatorSelection.userVerification |
string | ||
view.enrol.pending.options.credProps |
boolean | ||
view.enrol.pending.options.hints |
list | ||
view.enrol.pending.options.hints[] |
string | ||
view.enrol.pending.options.minPinLength |
boolean | ||
view.enrol.pending.options.rp |
object | ||
view.enrol.pending.options.rp.id |
string | ||
view.enrol.pending.options.rp.name |
string | ||
view.enrol.pending.options.timeout |
number | ||
view.enrol.pending.rpId |
string | ||
view.enrol.pending.user |
string | ||
view.enrol.pending.userHandle |
string | ||
view.keys |
list | ||
view.keys[].aaguid |
string | ||
view.keys[].algorithm |
object | ||
view.keys[].algorithm.insecure |
boolean | ||
view.keys[].algorithm.postQuantum |
boolean | ||
view.keys[].algorithm.text |
string | ||
view.keys[].attestation |
object | ||
view.keys[].attestation.androidStatus |
string | ||
view.keys[].attestation.deviceSerial |
string | ||
view.keys[].attestation.model |
string | ||
view.keys[].attestation.trusted |
boolean | ||
view.keys[].attestation.type |
string | ||
view.keys[].attestation.verified |
boolean | ||
view.keys[].attestationRefused |
string | ||
view.keys[].backupEligible |
boolean, or null | ||
view.keys[].backupState |
boolean | ||
view.keys[].credentialId |
string | ||
view.keys[].enrolledAt |
string or number, or null | ||
view.keys[].group |
string | ||
view.keys[].kind |
string | ||
view.keys[].lane |
string | ||
view.keys[].lastUsedAt |
string or number, or null | ||
view.keys[].name |
string | ||
view.keys[].pinRefused |
string | ||
view.keys[].possiblyReplaced |
object | ||
view.keys[].possiblyReplaced.at |
number | ||
view.keys[].postQuantumRefused |
boolean | ||
view.keys[].provider |
string | ||
view.keys[].syncedRefused |
boolean | ||
view.keys[].transports |
list | ||
view.keys[].transports[] |
string | ||
view.keys[].upgrade |
object | ||
view.keys[].upgrade.mode |
string | ||
view.keys[].upgrade.previousAlgorithm |
string | ||
view.keys[].upgrade.previousCredentialId |
string | ||
view.keys[].upgrade.upgradedAt |
number | ||
view.keys[].upgrade.upgradedTo |
string | ||
view.keys[].withoutUsername |
string | ||
view.mfaRequired |
boolean | ||
view.password |
boolean | ||
view.signals |
list | ||
view.signals[].accepted |
list | ||
view.signals[].accepted[] |
string | ||
view.signals[].display |
string | ||
view.signals[].lane |
string | ||
view.signals[].name |
string | ||
view.signals[].rpId |
string | ||
view.signals[].userId |
string |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
500: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.enrol |
object | ||
view.enrol.allowed |
boolean | ||
view.enrol.atCap |
boolean | ||
view.enrol.count |
integer | ||
view.enrol.enabled |
boolean | ||
view.enrol.kinds |
list | ||
view.enrol.kinds[] |
string | ||
view.enrol.lanes |
list | ||
view.enrol.lanes[] |
string | ||
view.enrol.pending |
object | ||
view.enrol.pending.challenge |
string | ||
view.enrol.pending.display |
string | ||
view.enrol.pending.exclude |
list | ||
view.enrol.pending.exclude[] |
string | ||
view.enrol.pending.fallback |
object | ||
view.enrol.pending.fallback.asksPostQuantum |
boolean | ||
view.enrol.pending.fallback.classical |
boolean | ||
view.enrol.pending.fallback.retrying |
boolean | ||
view.enrol.pending.id |
string | ||
view.enrol.pending.kind |
string | ||
view.enrol.pending.lane |
string | ||
view.enrol.pending.options |
object | ||
view.enrol.pending.options.algorithms |
list | ||
view.enrol.pending.options.algorithms[] |
integer | ||
view.enrol.pending.options.attestation |
string | ||
view.enrol.pending.options.authenticatorSelection |
object | ||
view.enrol.pending.options.authenticatorSelection.authenticatorAttachment |
string | ||
view.enrol.pending.options.authenticatorSelection.requireResidentKey |
boolean | ||
view.enrol.pending.options.authenticatorSelection.residentKey |
string | ||
view.enrol.pending.options.authenticatorSelection.userVerification |
string | ||
view.enrol.pending.options.credProps |
boolean | ||
view.enrol.pending.options.hints |
list | ||
view.enrol.pending.options.hints[] |
string | ||
view.enrol.pending.options.minPinLength |
boolean | ||
view.enrol.pending.options.rp |
object | ||
view.enrol.pending.options.rp.id |
string | ||
view.enrol.pending.options.rp.name |
string | ||
view.enrol.pending.options.timeout |
number | ||
view.enrol.pending.rpId |
string | ||
view.enrol.pending.user |
string | ||
view.enrol.pending.userHandle |
string | ||
view.keys |
list | ||
view.keys[].aaguid |
string | ||
view.keys[].algorithm |
object | ||
view.keys[].algorithm.insecure |
boolean | ||
view.keys[].algorithm.postQuantum |
boolean | ||
view.keys[].algorithm.text |
string | ||
view.keys[].attestation |
object | ||
view.keys[].attestation.androidStatus |
string | ||
view.keys[].attestation.deviceSerial |
string | ||
view.keys[].attestation.model |
string | ||
view.keys[].attestation.trusted |
boolean | ||
view.keys[].attestation.type |
string | ||
view.keys[].attestation.verified |
boolean | ||
view.keys[].attestationRefused |
string | ||
view.keys[].backupEligible |
boolean, or null | ||
view.keys[].backupState |
boolean | ||
view.keys[].credentialId |
string | ||
view.keys[].enrolledAt |
string or number, or null | ||
view.keys[].group |
string | ||
view.keys[].kind |
string | ||
view.keys[].lane |
string | ||
view.keys[].lastUsedAt |
string or number, or null | ||
view.keys[].name |
string | ||
view.keys[].pinRefused |
string | ||
view.keys[].possiblyReplaced |
object | ||
view.keys[].possiblyReplaced.at |
number | ||
view.keys[].postQuantumRefused |
boolean | ||
view.keys[].provider |
string | ||
view.keys[].syncedRefused |
boolean | ||
view.keys[].transports |
list | ||
view.keys[].transports[] |
string | ||
view.keys[].upgrade |
object | ||
view.keys[].upgrade.mode |
string | ||
view.keys[].upgrade.previousAlgorithm |
string | ||
view.keys[].upgrade.previousCredentialId |
string | ||
view.keys[].upgrade.upgradedAt |
number | ||
view.keys[].upgrade.upgradedTo |
string | ||
view.keys[].withoutUsername |
string | ||
view.mfaRequired |
boolean | ||
view.password |
boolean | ||
view.signals |
list | ||
view.signals[].accepted |
list | ||
view.signals[].accepted[] |
string | ||
view.signals[].display |
string | ||
view.signals[].lane |
string | ||
view.signals[].name |
string | ||
view.signals[].rpId |
string | ||
view.signals[].userId |
string |
POST /account-api/keys/remove
removeKey
Removes one of your passkeys
Refused where it would leave you no way to sign in. Your relying parties are told over CAEP, and every session the passkey signed in ends (sessionsEnded counts them, #722); your other sessions stay.
The door of the portal’s POST /portal/remove-key.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
credentialId |
``, or string | One of your own passkeys. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean | ||
sessionsEnded |
integer | ||
stepUp |
object | ||
stepUp.acrValues |
string | ||
stepUp.maxAge |
number | ||
stepUp.prompt |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.enrol |
object | ||
view.enrol.allowed |
boolean | ||
view.enrol.atCap |
boolean | ||
view.enrol.count |
integer | ||
view.enrol.enabled |
boolean | ||
view.enrol.kinds |
list | ||
view.enrol.kinds[] |
string | ||
view.enrol.lanes |
list | ||
view.enrol.lanes[] |
string | ||
view.enrol.pending |
object | ||
view.enrol.pending.challenge |
string | ||
view.enrol.pending.display |
string | ||
view.enrol.pending.exclude |
list | ||
view.enrol.pending.exclude[] |
string | ||
view.enrol.pending.fallback |
object | ||
view.enrol.pending.fallback.asksPostQuantum |
boolean | ||
view.enrol.pending.fallback.classical |
boolean | ||
view.enrol.pending.fallback.retrying |
boolean | ||
view.enrol.pending.id |
string | ||
view.enrol.pending.kind |
string | ||
view.enrol.pending.lane |
string | ||
view.enrol.pending.options |
object | ||
view.enrol.pending.options.algorithms |
list | ||
view.enrol.pending.options.algorithms[] |
integer | ||
view.enrol.pending.options.attestation |
string | ||
view.enrol.pending.options.authenticatorSelection |
object | ||
view.enrol.pending.options.authenticatorSelection.authenticatorAttachment |
string | ||
view.enrol.pending.options.authenticatorSelection.requireResidentKey |
boolean | ||
view.enrol.pending.options.authenticatorSelection.residentKey |
string | ||
view.enrol.pending.options.authenticatorSelection.userVerification |
string | ||
view.enrol.pending.options.credProps |
boolean | ||
view.enrol.pending.options.hints |
list | ||
view.enrol.pending.options.hints[] |
string | ||
view.enrol.pending.options.minPinLength |
boolean | ||
view.enrol.pending.options.rp |
object | ||
view.enrol.pending.options.rp.id |
string | ||
view.enrol.pending.options.rp.name |
string | ||
view.enrol.pending.options.timeout |
number | ||
view.enrol.pending.rpId |
string | ||
view.enrol.pending.user |
string | ||
view.enrol.pending.userHandle |
string | ||
view.keys |
list | ||
view.keys[].aaguid |
string | ||
view.keys[].algorithm |
object | ||
view.keys[].algorithm.insecure |
boolean | ||
view.keys[].algorithm.postQuantum |
boolean | ||
view.keys[].algorithm.text |
string | ||
view.keys[].attestation |
object | ||
view.keys[].attestation.androidStatus |
string | ||
view.keys[].attestation.deviceSerial |
string | ||
view.keys[].attestation.model |
string | ||
view.keys[].attestation.trusted |
boolean | ||
view.keys[].attestation.type |
string | ||
view.keys[].attestation.verified |
boolean | ||
view.keys[].attestationRefused |
string | ||
view.keys[].backupEligible |
boolean, or null | ||
view.keys[].backupState |
boolean | ||
view.keys[].credentialId |
string | ||
view.keys[].enrolledAt |
string or number, or null | ||
view.keys[].group |
string | ||
view.keys[].kind |
string | ||
view.keys[].lane |
string | ||
view.keys[].lastUsedAt |
string or number, or null | ||
view.keys[].name |
string | ||
view.keys[].pinRefused |
string | ||
view.keys[].possiblyReplaced |
object | ||
view.keys[].possiblyReplaced.at |
number | ||
view.keys[].postQuantumRefused |
boolean | ||
view.keys[].provider |
string | ||
view.keys[].syncedRefused |
boolean | ||
view.keys[].transports |
list | ||
view.keys[].transports[] |
string | ||
view.keys[].upgrade |
object | ||
view.keys[].upgrade.mode |
string | ||
view.keys[].upgrade.previousAlgorithm |
string | ||
view.keys[].upgrade.previousCredentialId |
string | ||
view.keys[].upgrade.upgradedAt |
number | ||
view.keys[].upgrade.upgradedTo |
string | ||
view.keys[].withoutUsername |
string | ||
view.mfaRequired |
boolean | ||
view.password |
boolean | ||
view.signals |
list | ||
view.signals[].accepted |
list | ||
view.signals[].accepted[] |
string | ||
view.signals[].display |
string | ||
view.signals[].lane |
string | ||
view.signals[].name |
string | ||
view.signals[].rpId |
string | ||
view.signals[].userId |
string |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/keys/rename
renameKey
Renames one of your passkeys
At most 60 characters, no control characters; an empty name puts the default back.
The door of the portal’s POST /portal/rename-key.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
credentialId |
``, or string | One of your own passkeys. | |
label |
string | Its new name; empty puts the default back. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.enrol |
object | ||
view.enrol.allowed |
boolean | ||
view.enrol.atCap |
boolean | ||
view.enrol.count |
integer | ||
view.enrol.enabled |
boolean | ||
view.enrol.kinds |
list | ||
view.enrol.kinds[] |
string | ||
view.enrol.lanes |
list | ||
view.enrol.lanes[] |
string | ||
view.enrol.pending |
object | ||
view.enrol.pending.challenge |
string | ||
view.enrol.pending.display |
string | ||
view.enrol.pending.exclude |
list | ||
view.enrol.pending.exclude[] |
string | ||
view.enrol.pending.fallback |
object | ||
view.enrol.pending.fallback.asksPostQuantum |
boolean | ||
view.enrol.pending.fallback.classical |
boolean | ||
view.enrol.pending.fallback.retrying |
boolean | ||
view.enrol.pending.id |
string | ||
view.enrol.pending.kind |
string | ||
view.enrol.pending.lane |
string | ||
view.enrol.pending.options |
object | ||
view.enrol.pending.options.algorithms |
list | ||
view.enrol.pending.options.algorithms[] |
integer | ||
view.enrol.pending.options.attestation |
string | ||
view.enrol.pending.options.authenticatorSelection |
object | ||
view.enrol.pending.options.authenticatorSelection.authenticatorAttachment |
string | ||
view.enrol.pending.options.authenticatorSelection.requireResidentKey |
boolean | ||
view.enrol.pending.options.authenticatorSelection.residentKey |
string | ||
view.enrol.pending.options.authenticatorSelection.userVerification |
string | ||
view.enrol.pending.options.credProps |
boolean | ||
view.enrol.pending.options.hints |
list | ||
view.enrol.pending.options.hints[] |
string | ||
view.enrol.pending.options.minPinLength |
boolean | ||
view.enrol.pending.options.rp |
object | ||
view.enrol.pending.options.rp.id |
string | ||
view.enrol.pending.options.rp.name |
string | ||
view.enrol.pending.options.timeout |
number | ||
view.enrol.pending.rpId |
string | ||
view.enrol.pending.user |
string | ||
view.enrol.pending.userHandle |
string | ||
view.keys |
list | ||
view.keys[].aaguid |
string | ||
view.keys[].algorithm |
object | ||
view.keys[].algorithm.insecure |
boolean | ||
view.keys[].algorithm.postQuantum |
boolean | ||
view.keys[].algorithm.text |
string | ||
view.keys[].attestation |
object | ||
view.keys[].attestation.androidStatus |
string | ||
view.keys[].attestation.deviceSerial |
string | ||
view.keys[].attestation.model |
string | ||
view.keys[].attestation.trusted |
boolean | ||
view.keys[].attestation.type |
string | ||
view.keys[].attestation.verified |
boolean | ||
view.keys[].attestationRefused |
string | ||
view.keys[].backupEligible |
boolean, or null | ||
view.keys[].backupState |
boolean | ||
view.keys[].credentialId |
string | ||
view.keys[].enrolledAt |
string or number, or null | ||
view.keys[].group |
string | ||
view.keys[].kind |
string | ||
view.keys[].lane |
string | ||
view.keys[].lastUsedAt |
string or number, or null | ||
view.keys[].name |
string | ||
view.keys[].pinRefused |
string | ||
view.keys[].possiblyReplaced |
object | ||
view.keys[].possiblyReplaced.at |
number | ||
view.keys[].postQuantumRefused |
boolean | ||
view.keys[].provider |
string | ||
view.keys[].syncedRefused |
boolean | ||
view.keys[].transports |
list | ||
view.keys[].transports[] |
string | ||
view.keys[].upgrade |
object | ||
view.keys[].upgrade.mode |
string | ||
view.keys[].upgrade.previousAlgorithm |
string | ||
view.keys[].upgrade.previousCredentialId |
string | ||
view.keys[].upgrade.upgradedAt |
number | ||
view.keys[].upgrade.upgradedTo |
string | ||
view.keys[].withoutUsername |
string | ||
view.mfaRequired |
boolean | ||
view.password |
boolean | ||
view.signals |
list | ||
view.signals[].accepted |
list | ||
view.signals[].accepted[] |
string | ||
view.signals[].display |
string | ||
view.signals[].lane |
string | ||
view.signals[].name |
string | ||
view.signals[].rpId |
string | ||
view.signals[].userId |
string |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/language
setLanguage
Sets or removes your preferred language
Writes preferredLanguage on your own entry (RFC 2798), which ranks above the browser for every page this service draws for you, and sets the language cookie; an empty lang removes it and follows the browser. A tag no catalog answers is refused.
The door of the portal’s POST /portal/language.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
lang |
string | A BCP 47 tag this service has a catalog for, or empty to follow the browser. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/locale
getLocale
The language data a page for nobody is drawn with
For the pages a person reaches with no sign-in — an activation or reset link, the forgot-password form, an address verification: the negotiation from the browser alone, the portal’s catalogs, the offered locales and the build.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
locale |
object | ||
locale.catalogs |
map | Each catalog along the chain, by language tag. | |
locale.catalogs.{key} |
map | A translated message by its key. | |
locale.catalogs.{key}.{key} |
string | ||
locale.negotiated |
object | ||
locale.negotiated.catalog |
string | ||
locale.negotiated.chain |
list | ||
locale.negotiated.chain[] |
string | ||
locale.negotiated.direction |
one of ltr, rtl |
||
locale.negotiated.locale |
string | ||
locale.negotiated.matched |
boolean | ||
locale.offered |
list | ||
locale.offered[].name |
string | ||
locale.offered[].tag |
string | ||
version |
object | ||
version.buildInfo |
string | ||
version.version |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/me
getMe
Who is signed in, and what every page is drawn with
The person (from the token, never the request), the realm, the language data — the negotiation, the portal’s catalogs and the locales offered — and the build. The portal draws its frame from it.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
client |
string | ||
expiresAt |
number, or null | ||
locale |
object | ||
locale.catalogs |
map | Each catalog along the chain, by language tag. | |
locale.catalogs.{key} |
map | A translated message by its key. | |
locale.catalogs.{key}.{key} |
string | ||
locale.negotiated |
object | ||
locale.negotiated.catalog |
string | ||
locale.negotiated.chain |
list | ||
locale.negotiated.chain[] |
string | ||
locale.negotiated.direction |
one of ltr, rtl |
||
locale.negotiated.locale |
string | ||
locale.negotiated.matched |
boolean | ||
locale.offered |
list | ||
locale.offered[].name |
string | ||
locale.offered[].tag |
string | ||
mode |
string | ||
realm |
object | ||
realm.id |
string | ||
realm.prefix |
string | ||
user |
object | ||
user.email |
string | ||
user.name |
string | ||
user.photo |
string | ||
user.sub |
string | ||
user.username |
string | ||
version |
object | ||
version.buildInfo |
string | ||
version.version |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/mfa
getMfa
Your authenticator app, emailed factor and recovery codes
totp: whether an authenticator app is set up (and its algorithm, digits, period, when set up and last used) and whether one is offered. setup: an enrolment in progress — the QR code as a data: image, the secret grouped for typing, the issuer and the parameters — derived from the pending secret on every call. doors: the password-only doors that refuse your own password. emailFactor: the emailed second factor, or null where none is offered. codes: your recovery codes’ state — never the codes, of which only hashes are stored.
The door of the portal’s GET /portal/mfa.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
codes |
object | ||
codes.advised |
boolean | ||
codes.count |
number, or null | ||
codes.enabled |
boolean | ||
codes.generatedAt |
string or number, or null | ||
codes.lastUsedAt |
string or number, or null | ||
codes.length |
number, or null | ||
codes.present |
boolean | ||
codes.remaining |
number | ||
codes.total |
number | ||
codes.usable |
boolean | ||
codes.why |
string | ||
doors |
object | ||
doors.applies |
boolean | ||
doors.refused |
list | ||
doors.refused[] |
string | ||
emailFactor |
object | ||
emailFactor.allowed |
object | ||
emailFactor.allowed.code |
boolean | ||
emailFactor.allowed.link |
boolean | ||
emailFactor.kind |
string | ||
emailFactor.masked |
string | ||
emailFactor.offered |
object | ||
emailFactor.offered.code |
boolean | ||
emailFactor.offered.link |
boolean | ||
emailFactor.optedIn |
string | ||
emailFactor.usable |
boolean | ||
emailFactor.verified |
boolean | ||
emailFactor.why |
string | ||
fresh |
object | ||
fresh.codes |
list | ||
fresh.codes[] |
string | ||
fresh.handle |
string | ||
fresh.replacing |
boolean | ||
setup |
object | ||
setup.algorithm |
string | ||
setup.digits |
number | ||
setup.grouped |
string | ||
setup.issuer |
string | ||
setup.period |
number | ||
setup.qr |
string | ||
totp |
object | ||
totp.detail |
object | ||
totp.detail.algorithm |
string | ||
totp.detail.digits |
number | ||
totp.detail.enrolledAt |
string or number, or null | ||
totp.detail.lastUsedAt |
string or number, or null | ||
totp.detail.period |
number | ||
totp.digits |
number, or null | ||
totp.enrolled |
boolean | ||
totp.offered |
boolean | ||
totp.period |
number, or null | ||
totp.usable |
boolean | ||
username |
string | ||
verifiesCredentials |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/mfa
changeMfa
Sets up, confirms or removes your second factors
start mints a secret and holds it (ask the view for the QR code); confirm checks a code from the app (rate limited) and enrols it; remove takes it off, and ends every session its codes signed in (sessionsEnded, #722). generate-codes answers a set of recovery codes ONCE, in view.fresh, and stores nothing; confirm-codes stores their hashes; discard-codes throws the pending set away. email-factor-on (with kind) and email-factor-off opt in and out of the emailed second factor. A refusal carries the page’s view.
The door of the portal’s POST /portal/mfa.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
action |
``, or one of start, confirm, remove, generate-codes, confirm-codes, discard-codes, email-factor-on, email-factor-off |
The step: start an authenticator app, confirm it with a code, remove it; generate-codes, confirm-codes or discard-codes a set of recovery codes; email-factor-on or email-factor-off. |
|
code |
string | For confirm: the code the app shows. |
|
handle |
string | For confirm-codes and discard-codes: the pending set’s handle, from generate-codes’s answer. |
|
kind |
``, or one of code, link |
For email-factor-on: a mailed code or a sign-in link. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean | ||
sessionsEnded |
integer | ||
stepUp |
object | ||
stepUp.acrValues |
string | ||
stepUp.maxAge |
number | ||
stepUp.prompt |
string | ||
view |
object | ||
view.codes |
object | ||
view.codes.advised |
boolean | ||
view.codes.count |
number, or null | ||
view.codes.enabled |
boolean | ||
view.codes.generatedAt |
string or number, or null | ||
view.codes.lastUsedAt |
string or number, or null | ||
view.codes.length |
number, or null | ||
view.codes.present |
boolean | ||
view.codes.remaining |
number | ||
view.codes.total |
number | ||
view.codes.usable |
boolean | ||
view.codes.why |
string | ||
view.doors |
object | ||
view.doors.applies |
boolean | ||
view.doors.refused |
list | ||
view.doors.refused[] |
string | ||
view.emailFactor |
object | ||
view.emailFactor.allowed |
object | ||
view.emailFactor.allowed.code |
boolean | ||
view.emailFactor.allowed.link |
boolean | ||
view.emailFactor.kind |
string | ||
view.emailFactor.masked |
string | ||
view.emailFactor.offered |
object | ||
view.emailFactor.offered.code |
boolean | ||
view.emailFactor.offered.link |
boolean | ||
view.emailFactor.optedIn |
string | ||
view.emailFactor.usable |
boolean | ||
view.emailFactor.verified |
boolean | ||
view.emailFactor.why |
string | ||
view.fresh |
object | ||
view.fresh.codes |
list | ||
view.fresh.codes[] |
string | ||
view.fresh.handle |
string | ||
view.fresh.replacing |
boolean | ||
view.setup |
object | ||
view.setup.algorithm |
string | ||
view.setup.digits |
number | ||
view.setup.grouped |
string | ||
view.setup.issuer |
string | ||
view.setup.period |
number | ||
view.setup.qr |
string | ||
view.totp |
object | ||
view.totp.detail |
object | ||
view.totp.detail.algorithm |
string | ||
view.totp.detail.digits |
number | ||
view.totp.detail.enrolledAt |
string or number, or null | ||
view.totp.detail.lastUsedAt |
string or number, or null | ||
view.totp.detail.period |
number | ||
view.totp.digits |
number, or null | ||
view.totp.enrolled |
boolean | ||
view.totp.offered |
boolean | ||
view.totp.period |
number, or null | ||
view.totp.usable |
boolean | ||
view.username |
string | ||
view.verifiesCredentials |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.codes |
object | ||
view.codes.advised |
boolean | ||
view.codes.count |
number, or null | ||
view.codes.enabled |
boolean | ||
view.codes.generatedAt |
string or number, or null | ||
view.codes.lastUsedAt |
string or number, or null | ||
view.codes.length |
number, or null | ||
view.codes.present |
boolean | ||
view.codes.remaining |
number | ||
view.codes.total |
number | ||
view.codes.usable |
boolean | ||
view.codes.why |
string | ||
view.doors |
object | ||
view.doors.applies |
boolean | ||
view.doors.refused |
list | ||
view.doors.refused[] |
string | ||
view.emailFactor |
object | ||
view.emailFactor.allowed |
object | ||
view.emailFactor.allowed.code |
boolean | ||
view.emailFactor.allowed.link |
boolean | ||
view.emailFactor.kind |
string | ||
view.emailFactor.masked |
string | ||
view.emailFactor.offered |
object | ||
view.emailFactor.offered.code |
boolean | ||
view.emailFactor.offered.link |
boolean | ||
view.emailFactor.optedIn |
string | ||
view.emailFactor.usable |
boolean | ||
view.emailFactor.verified |
boolean | ||
view.emailFactor.why |
string | ||
view.fresh |
object | ||
view.fresh.codes |
list | ||
view.fresh.codes[] |
string | ||
view.fresh.handle |
string | ||
view.fresh.replacing |
boolean | ||
view.setup |
object | ||
view.setup.algorithm |
string | ||
view.setup.digits |
number | ||
view.setup.grouped |
string | ||
view.setup.issuer |
string | ||
view.setup.period |
number | ||
view.setup.qr |
string | ||
view.totp |
object | ||
view.totp.detail |
object | ||
view.totp.detail.algorithm |
string | ||
view.totp.detail.digits |
number | ||
view.totp.detail.enrolledAt |
string or number, or null | ||
view.totp.detail.lastUsedAt |
string or number, or null | ||
view.totp.detail.period |
number | ||
view.totp.digits |
number, or null | ||
view.totp.enrolled |
boolean | ||
view.totp.offered |
boolean | ||
view.totp.period |
number, or null | ||
view.totp.usable |
boolean | ||
view.username |
string | ||
view.verifiesCredentials |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
429: Too many codes tried; try again later.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.codes |
object | ||
view.codes.advised |
boolean | ||
view.codes.count |
number, or null | ||
view.codes.enabled |
boolean | ||
view.codes.generatedAt |
string or number, or null | ||
view.codes.lastUsedAt |
string or number, or null | ||
view.codes.length |
number, or null | ||
view.codes.present |
boolean | ||
view.codes.remaining |
number | ||
view.codes.total |
number | ||
view.codes.usable |
boolean | ||
view.codes.why |
string | ||
view.doors |
object | ||
view.doors.applies |
boolean | ||
view.doors.refused |
list | ||
view.doors.refused[] |
string | ||
view.emailFactor |
object | ||
view.emailFactor.allowed |
object | ||
view.emailFactor.allowed.code |
boolean | ||
view.emailFactor.allowed.link |
boolean | ||
view.emailFactor.kind |
string | ||
view.emailFactor.masked |
string | ||
view.emailFactor.offered |
object | ||
view.emailFactor.offered.code |
boolean | ||
view.emailFactor.offered.link |
boolean | ||
view.emailFactor.optedIn |
string | ||
view.emailFactor.usable |
boolean | ||
view.emailFactor.verified |
boolean | ||
view.emailFactor.why |
string | ||
view.fresh |
object | ||
view.fresh.codes |
list | ||
view.fresh.codes[] |
string | ||
view.fresh.handle |
string | ||
view.fresh.replacing |
boolean | ||
view.setup |
object | ||
view.setup.algorithm |
string | ||
view.setup.digits |
number | ||
view.setup.grouped |
string | ||
view.setup.issuer |
string | ||
view.setup.period |
number | ||
view.setup.qr |
string | ||
view.totp |
object | ||
view.totp.detail |
object | ||
view.totp.detail.algorithm |
string | ||
view.totp.detail.digits |
number | ||
view.totp.detail.enrolledAt |
string or number, or null | ||
view.totp.detail.lastUsedAt |
string or number, or null | ||
view.totp.detail.period |
number | ||
view.totp.digits |
number, or null | ||
view.totp.enrolled |
boolean | ||
view.totp.offered |
boolean | ||
view.totp.period |
number, or null | ||
view.totp.usable |
boolean | ||
view.username |
string | ||
view.verifiesCredentials |
boolean |
GET /account-api/openapi.json
getOpenApi
This API’s OpenAPI 3.1 document
Built from the operation table at the moment it is asked, for the realm it is asked in. It carries no secret.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
components |
any JSON | The inside of an OpenAPI document (its paths and components): a statement about this API in OpenAPI’s own vocabulary, whose every model is stated at the operation it describes. The inside of an OpenAPI document (its paths and components): a statement about this API in OpenAPI’s own vocabulary, whose every model is stated at the operation it describes. | |
info |
object | ||
info.description |
string | ||
info.title |
string | ||
info.version |
string | ||
openapi |
string | ||
paths |
any JSON | The inside of an OpenAPI document (its paths and components): a statement about this API in OpenAPI’s own vocabulary, whose every model is stated at the operation it describes. The inside of an OpenAPI document (its paths and components): a statement about this API in OpenAPI’s own vocabulary, whose every model is stated at the operation it describes. | |
servers |
list | ||
servers[].url |
string | ||
tags |
list | ||
tags[].name |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/overview
getOverview
Who you are, this session, and how you sign in
Your username, subject and directory entry’s DN; when the sign-on session began, how it authenticated (amr, acr) and when it ends; every standard inetOrgPerson attribute your entry holds, from a fixed list (directory, null with no directory or no entry — then session carries what the sign-in said); a summary of your credentials (mechanisms); the language your entry holds with those offered (language); and the realm’s custom attributes whose definition shows them on the portal, with your values and whether you may change them (customAttributes, empty with no entry).
The door of the portal’s GET /portal.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
done |
query | string | ||
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
customAttributes |
list | ||
customAttributes[].description |
string | ||
customAttributes[].editable |
boolean | ||
customAttributes[].label |
string | ||
customAttributes[].multi |
boolean | ||
customAttributes[].name |
string | ||
customAttributes[].syntax |
string | ||
customAttributes[].values |
list | ||
customAttributes[].values[] |
string | ||
directory |
object | ||
directory.classes |
list | ||
directory.classes[].held |
integer | ||
directory.classes[].id |
string | ||
directory.classes[].name |
string | ||
directory.classes[].oid |
string | ||
directory.classes[].rfc |
string | ||
directory.classes[].rows |
list | ||
directory.classes[].rows[].binary |
boolean | ||
directory.classes[].rows[].bytes |
integer | ||
directory.classes[].rows[].count |
integer | ||
directory.classes[].rows[].label |
string | ||
directory.classes[].rows[].ldap |
string | ||
directory.classes[].rows[].must |
boolean | ||
directory.classes[].rows[].note |
string | ||
directory.classes[].rows[].present |
boolean | ||
directory.classes[].rows[].rfc |
string | ||
directory.classes[].rows[].secret |
boolean | ||
directory.classes[].rows[].values |
list | ||
directory.classes[].rows[].values[] |
string | ||
directory.classes[].total |
integer | ||
directory.classes[].what |
string | ||
directory.held |
integer | ||
directory.total |
integer | ||
entry |
object | ||
entry.dn |
string | ||
language |
object | ||
language.held |
string | ||
language.offered |
list | ||
language.offered[].name |
string | ||
language.offered[].tag |
string | ||
mechanisms |
object | ||
mechanisms.backupCodes |
object | ||
mechanisms.backupCodes.present |
boolean | ||
mechanisms.backupCodes.remaining |
number | ||
mechanisms.backupCodes.total |
number | ||
mechanisms.backupCodes.usable |
boolean | ||
mechanisms.keys |
integer | ||
mechanisms.mfaRequired |
boolean | ||
mechanisms.password |
boolean | ||
mechanisms.secondFactor |
string | ||
mechanisms.totp |
boolean | ||
mechanisms.totpUsable |
boolean | ||
photo |
object | ||
photo.limits |
object | ||
photo.limits.maxFileBytes |
number | ||
photo.limits.maxPixels |
number | ||
photo.limits.maxStoredBytes |
number | ||
photo.limits.minPixels |
number | ||
photo.limits.types |
list | ||
photo.limits.types[] |
string | ||
photo.origin |
string | ||
photo.path |
string | ||
photo.selfService |
boolean | ||
session |
object | ||
session.email |
string | ||
session.name |
string | ||
sessionEnds |
number | ||
signOn |
object | ||
signOn.acr |
string | ||
signOn.amr |
list | ||
signOn.amr[] |
string | ||
signOn.authTime |
number | ||
signOn.authentications |
number | ||
signOn.deviceBound |
object | ||
signOn.deviceBound.alg |
string | ||
signOn.deviceBound.bound |
boolean | ||
signOn.deviceBound.fact |
string | ||
signOn.deviceBound.reasons |
list | ||
signOn.deviceBound.reasons[] |
string | ||
signOn.startedAt |
number | ||
sub |
string | ||
timesSignedIn |
number, or null | ||
username |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/owned/applications
getOwnedApplications
What you own: applications
One page (paging, moved by page) of the applications whose appOwner values name you or a group you are in (#604), in name order. Each row’s via says how it is yours: you where an owner value is your own entry, and groups, the groups of yours it names. Since #607 an owner may administer what they own through /admin-api with owner:read and owner:write.
The door of the portal’s GET /portal/owned/applications.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
page |
query | Which page of rows. Clamped to the last. |
||
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
kind |
string | ||
paging |
object | ||
paging.page |
integer | ||
paging.pages |
integer | ||
paging.per |
integer | ||
paging.total |
integer | ||
rows |
list | ||
rows[].closed |
boolean | ||
rows[].detail |
string, or null | ||
rows[].dn |
string | ||
rows[].id |
string | ||
rows[].name |
string | ||
rows[].via |
object | ||
rows[].via.groups |
list | ||
rows[].via.groups[] |
string | ||
rows[].via.you |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/owned/groups
getOwnedGroups
What you own: groups
One page (paging, moved by page) of the groups whose owner values name you or a group you are in (#604), in name order. Each row’s via says how it is yours: you where an owner value is your own entry, and groups, the groups of yours it names. Since #607 an owner may administer what they own through /admin-api with owner:read and owner:write.
The door of the portal’s GET /portal/owned/groups.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
page |
query | Which page of rows. Clamped to the last. |
||
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
kind |
string | ||
paging |
object | ||
paging.page |
integer | ||
paging.pages |
integer | ||
paging.per |
integer | ||
paging.total |
integer | ||
rows |
list | ||
rows[].closed |
boolean | ||
rows[].detail |
string, or null | ||
rows[].dn |
string | ||
rows[].id |
string | ||
rows[].name |
string | ||
rows[].via |
object | ||
rows[].via.groups |
list | ||
rows[].via.groups[] |
string | ||
rows[].via.you |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/owned/roles
getOwnedRoles
What you own: roles
One page (paging, moved by page) of the roles whose owner values name you or a group you are in (#604), in name order. Each row’s via says how it is yours: you where an owner value is your own entry, and groups, the groups of yours it names. Since #607 an owner may administer what they own through /admin-api with owner:read and owner:write.
The door of the portal’s GET /portal/owned/roles.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
page |
query | Which page of rows. Clamped to the last. |
||
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
kind |
string | ||
paging |
object | ||
paging.page |
integer | ||
paging.pages |
integer | ||
paging.per |
integer | ||
paging.total |
integer | ||
rows |
list | ||
rows[].closed |
boolean | ||
rows[].detail |
string, or null | ||
rows[].dn |
string | ||
rows[].id |
string | ||
rows[].name |
string | ||
rows[].via |
object | ||
rows[].via.groups |
list | ||
rows[].via.groups[] |
string | ||
rows[].via.you |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/owned/service-accounts
getOwnedServiceAccounts
What you own: service accounts
One page (paging, moved by page) of the service accounts whose stsServiceAccountOwner values name you or a group you are in (#604), in name order. Each row’s via says how it is yours: you where an owner value is your own entry, and groups, the groups of yours it names. Since #607 an owner may administer what they own through /admin-api with owner:read and owner:write.
The door of the portal’s GET /portal/owned/service-accounts.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
page |
query | Which page of rows. Clamped to the last. |
||
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
kind |
string | ||
paging |
object | ||
paging.page |
integer | ||
paging.pages |
integer | ||
paging.per |
integer | ||
paging.total |
integer | ||
rows |
list | ||
rows[].closed |
boolean | ||
rows[].detail |
string, or null | ||
rows[].dn |
string | ||
rows[].id |
string | ||
rows[].name |
string | ||
rows[].via |
object | ||
rows[].via.groups |
list | ||
rows[].via.groups[] |
string | ||
rows[].via.you |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/password
getPassword
Whether you have a password, and what one must be
hasPassword, and rules: the password policy’s rules for you (enforced false in development mode, where nothing is checked).
The door of the portal’s GET /portal/password.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
hasPassword |
boolean | ||
rules |
object | ||
rules.enforced |
boolean | ||
rules.rules |
list | ||
rules.rules[] |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/password
changePassword
Changes your password
Re-proves the current password (rate limited, in the budget the Kerberos keytab shares), screens the new one against breached passwords, applies the password policy, and tells your relying parties over CAEP. A refusal carries the page’s view.
The door of the portal’s POST /portal/password.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
confirm |
string | The new password again. | |
current |
string | Your current password: a change re-proves it. | |
next |
string | The new password. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.hasPassword |
boolean | ||
view.rules |
object | ||
view.rules.enforced |
boolean | ||
view.rules.rules |
list | ||
view.rules.rules[] |
string |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
429: Too many attempts; try again later.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.hasPassword |
boolean | ||
view.rules |
object | ||
view.rules.enforced |
boolean | ||
view.rules.rules |
list | ||
view.rules.rules[] |
string |
POST /account-api/photo
setProfilePhoto
Sets your profile photo
Keeps image, a base64-encoded JPEG or PNG, as your photo: its metadata is removed, it gets a new random address, and the picture claim names that address from now on. The file’s bytes decide its type, and the realm’s limits are on the Overview’s photo.limits.
The door of the portal’s POST /portal/photo.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
image |
string | yes | The JPEG or PNG file, base64-encoded. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean | ||
photo |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
409: Product mode, with no public base URL pinned.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
413: The file is larger than the realm keeps.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/photo/remove
removeProfilePhoto
Removes your profile photo
Removes the image and the picture claim’s address. A copy from a federation partner stays removed: the next sign-in through them does not bring it back.
The door of the portal’s POST /portal/photo/remove.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean | ||
photo |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/pseudonyms
getPseudonyms
The other names you can sign in with
pseudonyms are live. pending is an email that is not a name until its link is opened. cap is eight. available says whether an email can be mailed a link.
The door of the portal’s GET /portal/pseudonyms.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
available |
boolean | ||
cap |
number | ||
pending |
string, or null | ||
pseudonyms |
list | ||
pseudonyms[] |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
503: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.refused |
string |
POST /account-api/pseudonyms
postPseudonyms
Adds, removes or cancels one sign-in name
add of an email mails a link to /portal/verify-pseudonym and is not a name until that link is used, unless the address is already your verified one. Any other name is live at once. remove drops a live name. cancel-pending drops a name waiting for its link. Adding is rate limited. The link’s secret is not in the answer.
The door of the portal’s POST /portal/pseudonyms.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
action |
``, or one of add, remove, cancel-pending |
add adds value; remove drops it; cancel-pending drops a name that is waiting for its link. |
|
value |
string | The name, for add and remove. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.available |
boolean | ||
view.cap |
number | ||
view.pending |
string, or null | ||
view.pseudonyms |
list | ||
view.pseudonyms[] |
string | ||
view.refused |
string |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
429: Too many attempts; try again later.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.available |
boolean | ||
view.cap |
number | ||
view.pending |
string, or null | ||
view.pseudonyms |
list | ||
view.pseudonyms[] |
string | ||
view.refused |
string |
503: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.available |
boolean | ||
view.cap |
number | ||
view.pending |
string, or null | ||
view.pseudonyms |
list | ||
view.pseudonyms[] |
string | ||
view.refused |
string |
GET /account-api/reset-password
getPasswordReset
Checks a password reset link, and spends nothing
Takes no token: the link’s user and token are the credential. Answers the form’s view — the username, the service’s address and the password rules — or one sentence for every way a link can fail (view.refused), so nobody learns which usernames have a link outstanding. Rate limited.
The door of the portal’s GET /portal/reset-password.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
user |
query | The username the link names. | ||
X-Link-Token |
header | string | The single-use secret the link carried in its fragment. | |
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
base |
string | ||
done |
boolean | ||
refused |
string | ||
rules |
object | ||
rules.enforced |
boolean | ||
rules.rules |
list | ||
rules.rules[] |
string | ||
signIn |
string | ||
token |
string | ||
tooMany |
boolean | ||
username |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.base |
string | ||
view.done |
boolean | ||
view.refused |
string | ||
view.rules |
object | ||
view.rules.enforced |
boolean | ||
view.rules.rules |
list | ||
view.rules.rules[] |
string | ||
view.signIn |
string | ||
view.token |
string | ||
view.tooMany |
boolean | ||
view.username |
string |
403: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.base |
string | ||
view.done |
boolean | ||
view.refused |
string | ||
view.rules |
object | ||
view.rules.enforced |
boolean | ||
view.rules.rules |
list | ||
view.rules.rules[] |
string | ||
view.signIn |
string | ||
view.token |
string | ||
view.tooMany |
boolean | ||
view.username |
string |
429: Too many attempts; view.refused says so.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.base |
string | ||
view.done |
boolean | ||
view.refused |
string | ||
view.rules |
object | ||
view.rules.enforced |
boolean | ||
view.rules.rules |
list | ||
view.rules.rules[] |
string | ||
view.signIn |
string | ||
view.token |
string | ||
view.tooMany |
boolean | ||
view.username |
string |
POST /account-api/reset-password
spendPasswordReset
Sets a new password from a reset link, and spends it
Checks the link again, claims it, screens the password against breached passwords and the password policy, stores it, clears the must-change flag, and spends the link; signs nobody in. CAEP credential-change is sent. A refusal carries the page’s view; success answers view.done.
The door of the portal’s POST /portal/reset-password.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
confirm |
string | The new password again. | |
password |
string | The new password. | |
token |
``, or string | The link’s single-use secret. | |
user |
``, or string | The username the link names. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean | ||
view |
object | ||
view.base |
string | ||
view.done |
boolean | ||
view.refused |
string | ||
view.rules |
object | ||
view.rules.enforced |
boolean | ||
view.rules.rules |
list | ||
view.rules.rules[] |
string | ||
view.signIn |
string | ||
view.token |
string | ||
view.tooMany |
boolean | ||
view.username |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.base |
string | ||
view.done |
boolean | ||
view.refused |
string | ||
view.rules |
object | ||
view.rules.enforced |
boolean | ||
view.rules.rules |
list | ||
view.rules.rules[] |
string | ||
view.signIn |
string | ||
view.token |
string | ||
view.tooMany |
boolean | ||
view.username |
string |
403: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.base |
string | ||
view.done |
boolean | ||
view.refused |
string | ||
view.rules |
object | ||
view.rules.enforced |
boolean | ||
view.rules.rules |
list | ||
view.rules.rules[] |
string | ||
view.signIn |
string | ||
view.token |
string | ||
view.tooMany |
boolean | ||
view.username |
string |
429: Too many attempts; view.refused says so.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.base |
string | ||
view.done |
boolean | ||
view.refused |
string | ||
view.rules |
object | ||
view.rules.enforced |
boolean | ||
view.rules.rules |
list | ||
view.rules.rules[] |
string | ||
view.signIn |
string | ||
view.token |
string | ||
view.tooMany |
boolean | ||
view.username |
string |
500: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.base |
string | ||
view.done |
boolean | ||
view.refused |
string | ||
view.rules |
object | ||
view.rules.enforced |
boolean | ||
view.rules.rules |
list | ||
view.rules.rules[] |
string | ||
view.signIn |
string | ||
view.token |
string | ||
view.tooMany |
boolean | ||
view.username |
string |
GET /account-api/self-issued
getSelfIssued
The wallet keys that sign you in with SIOPv2
subjects: each enrolled self-issued subject (a DID or a JWK thumbprint), its label, when and by whom it was enrolled, and how (proof: wallet, proved by you, or admin, by an administrator), whether it is your preferred DID (preferred, #693), and where the key came from (location: { kind, value } — web, the web wallet at that address; app, a wallet app, by the name it reported or ‘’; dc_api, your browser, by its origin or ‘’; admin; or null, not recorded), and where its DID document is (didDocumentUrl, a did:web’s published address, or didResolved, a did:jwk or did:key resolved from the identifier at /portal/self-issued/did). enabled: whether the self-issued sign-in is on; turnOn, where it is off: the setting (setting) and environment variable (env) that turn it on, whether you may change it (administrator: you hold Admin Write in this realm) and, if you may, the console page that does (page); null where it is on. didClaim: whether the preferred DID may be released as the did claim here. A key is enrolled by proving it, at /authn/wallet?siop=1&enrol=1, which comes back with enrolled=1; notice then says so. Where the directory holds no entry for the person the token names it is refused (STS-PORTAL-0616) rather than answered as an empty list. published (#1291): whether this realm publishes a did:web for you (enabled), who holds its key (custody: wallet, realm or download), how many you may hold (maxPerPerson) and hold now (active), whether you may publish one more (canPublish), and each one you hold (dids): its rid, did, documentUrl, custody, state (active, deactivated), proof, preferred, currentVersion, any change waiting for its new key (pending) and its versions, each with its keys and what authorized it. A wallet act that just finished comes back with did (published, authorized or changed), and notice says so.
The door of the portal’s GET /portal/self-issued.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
enrolled |
query | 1 when the wallet sign-in has just enrolled a subject. |
||
did |
query | A published DID’s wallet act that has just finished (#1291): published, authorized (the change’s first proof; prove the new key next) or changed. |
||
rid |
query | The published DID that act was about. | ||
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
didClaim |
boolean | ||
enabled |
boolean | ||
fresh |
object | ||
fresh.did |
string | ||
fresh.file |
object | ||
fresh.file.base64 |
string | ||
fresh.file.mime |
string | ||
fresh.file.name |
string | ||
fresh.kind |
string | ||
fresh.rid |
string | ||
loginHint |
string | ||
notice |
string | ||
published |
object | ||
published.active |
integer | ||
published.canPublish |
boolean | ||
published.custody |
string | ||
published.dids |
list | ||
published.dids[].by |
string, or null | ||
published.dids[].createdAt |
string or number, or null | ||
published.dids[].currentVersion |
number | ||
published.dids[].custody |
string | ||
published.dids[].deactivated |
object | ||
published.dids[].deactivated.at |
string | ||
published.dids[].deactivated.by |
string, or null | ||
published.dids[].deactivated.reason |
string, or null | ||
published.dids[].did |
string | ||
published.dids[].documentUrl |
string | ||
published.dids[].pending |
object | ||
published.dids[].pending.change |
string | ||
published.dids[].pending.expiresAt |
string | ||
published.dids[].preferred |
boolean | ||
published.dids[].proof |
string | ||
published.dids[].rid |
string | ||
published.dids[].state |
string | ||
published.dids[].versions |
list | ||
published.dids[].versions[].authorizedBy |
list | ||
published.dids[].versions[].authorizedBy[].actor |
string | ||
published.dids[].versions[].authorizedBy[].at |
string | ||
published.dids[].versions[].authorizedBy[].keyThumbprint |
string | ||
published.dids[].versions[].authorizedBy[].kind |
string | ||
published.dids[].versions[].authorizedBy[].subject |
string | ||
published.dids[].versions[].authorizedBy[].transaction |
string | ||
published.dids[].versions[].authorizedBy[].versionId |
number | ||
published.dids[].versions[].change |
string | ||
published.dids[].versions[].created |
string or number, or null | ||
published.dids[].versions[].keys |
list | ||
published.dids[].versions[].keys[].alg |
string | ||
published.dids[].versions[].keys[].crv |
string | ||
published.dids[].versions[].keys[].id |
string | ||
published.dids[].versions[].keys[].kty |
string | ||
published.dids[].versions[].versionId |
number | ||
published.enabled |
boolean | ||
published.keyAlgorithm |
string | ||
published.maxPerPerson |
number | ||
subjects |
list | ||
subjects[].by |
string | ||
subjects[].didDocumentUrl |
string | ||
subjects[].didResolved |
boolean | ||
subjects[].enrolledAt |
string or number, or null | ||
subjects[].label |
string | ||
subjects[].location |
object | ||
subjects[].location.kind |
string | ||
subjects[].location.value |
string | ||
subjects[].preferred |
boolean | ||
subjects[].proof |
string | ||
subjects[].subject |
string | ||
turnOn |
object | ||
turnOn.administrator |
boolean | ||
turnOn.env |
string | ||
turnOn.page |
string, or null | ||
turnOn.setting |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
404: The directory holds no entry for the token’s person (STS-PORTAL-0616).
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/self-issued
removeSelfIssued
Removes a self-issued subject of yours, or marks one as your preferred DID
remove (the default): the subject no longer signs you in. One that is not enrolled for you is refused. prefer (#693): marks one DID you PROVED with your wallet as your preferred one — the one a client you consent to may be told as the did claim, where the realm releases it (oauth2.didClaim); a subject an administrator added, or a JWK thumbprint, is refused (STS-PORTAL-0615). unprefer clears the mark. Removing the preferred subject clears it too.
The door of the portal’s POST /portal/self-issued.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
action |
``, or one of remove, prefer, unprefer |
remove (the default) takes the subject off; prefer marks it as your preferred DID (#693), and unprefer clears the mark. |
|
subject |
string | yes | The enrolled subject, from the list. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean | ||
stepUp |
object | ||
stepUp.acrValues |
string | ||
stepUp.maxAge |
number | ||
stepUp.prompt |
string | ||
view |
object | ||
view.didClaim |
boolean | ||
view.enabled |
boolean | ||
view.fresh |
object | ||
view.fresh.did |
string | ||
view.fresh.file |
object | ||
view.fresh.file.base64 |
string | ||
view.fresh.file.mime |
string | ||
view.fresh.file.name |
string | ||
view.fresh.kind |
string | ||
view.fresh.rid |
string | ||
view.loginHint |
string | ||
view.notice |
string | ||
view.published |
object | ||
view.published.active |
integer | ||
view.published.canPublish |
boolean | ||
view.published.custody |
string | ||
view.published.dids |
list | ||
view.published.dids[].by |
string, or null | ||
view.published.dids[].createdAt |
string or number, or null | ||
view.published.dids[].currentVersion |
number | ||
view.published.dids[].custody |
string | ||
view.published.dids[].deactivated |
object | ||
view.published.dids[].deactivated.at |
string | ||
view.published.dids[].deactivated.by |
string, or null | ||
view.published.dids[].deactivated.reason |
string, or null | ||
view.published.dids[].did |
string | ||
view.published.dids[].documentUrl |
string | ||
view.published.dids[].pending |
object | ||
view.published.dids[].pending.change |
string | ||
view.published.dids[].pending.expiresAt |
string | ||
view.published.dids[].preferred |
boolean | ||
view.published.dids[].proof |
string | ||
view.published.dids[].rid |
string | ||
view.published.dids[].state |
string | ||
view.published.dids[].versions |
list | ||
view.published.dids[].versions[].authorizedBy |
list | ||
view.published.dids[].versions[].authorizedBy[].actor |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].at |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].keyThumbprint |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].kind |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].subject |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].transaction |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].versionId |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].change |
string | ||
view.published.dids[].versions[].created |
string or number, or null | ||
view.published.dids[].versions[].keys |
list | ||
view.published.dids[].versions[].keys[].alg |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].keys[].crv |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].keys[].id |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].keys[].kty |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].versionId |
number | ||
view.published.enabled |
boolean | ||
view.published.keyAlgorithm |
string | ||
view.published.maxPerPerson |
number | ||
view.subjects |
list | ||
view.subjects[].by |
string | ||
view.subjects[].didDocumentUrl |
string | ||
view.subjects[].didResolved |
boolean | ||
view.subjects[].enrolledAt |
string or number, or null | ||
view.subjects[].label |
string | ||
view.subjects[].location |
object | ||
view.subjects[].location.kind |
string | ||
view.subjects[].location.value |
string | ||
view.subjects[].preferred |
boolean | ||
view.subjects[].proof |
string | ||
view.subjects[].subject |
string | ||
view.turnOn |
object | ||
view.turnOn.administrator |
boolean | ||
view.turnOn.env |
string | ||
view.turnOn.page |
string, or null | ||
view.turnOn.setting |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.didClaim |
boolean | ||
view.enabled |
boolean | ||
view.fresh |
object | ||
view.fresh.did |
string | ||
view.fresh.file |
object | ||
view.fresh.file.base64 |
string | ||
view.fresh.file.mime |
string | ||
view.fresh.file.name |
string | ||
view.fresh.kind |
string | ||
view.fresh.rid |
string | ||
view.loginHint |
string | ||
view.notice |
string | ||
view.published |
object | ||
view.published.active |
integer | ||
view.published.canPublish |
boolean | ||
view.published.custody |
string | ||
view.published.dids |
list | ||
view.published.dids[].by |
string, or null | ||
view.published.dids[].createdAt |
string or number, or null | ||
view.published.dids[].currentVersion |
number | ||
view.published.dids[].custody |
string | ||
view.published.dids[].deactivated |
object | ||
view.published.dids[].deactivated.at |
string | ||
view.published.dids[].deactivated.by |
string, or null | ||
view.published.dids[].deactivated.reason |
string, or null | ||
view.published.dids[].did |
string | ||
view.published.dids[].documentUrl |
string | ||
view.published.dids[].pending |
object | ||
view.published.dids[].pending.change |
string | ||
view.published.dids[].pending.expiresAt |
string | ||
view.published.dids[].preferred |
boolean | ||
view.published.dids[].proof |
string | ||
view.published.dids[].rid |
string | ||
view.published.dids[].state |
string | ||
view.published.dids[].versions |
list | ||
view.published.dids[].versions[].authorizedBy |
list | ||
view.published.dids[].versions[].authorizedBy[].actor |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].at |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].keyThumbprint |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].kind |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].subject |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].transaction |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].versionId |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].change |
string | ||
view.published.dids[].versions[].created |
string or number, or null | ||
view.published.dids[].versions[].keys |
list | ||
view.published.dids[].versions[].keys[].alg |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].keys[].crv |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].keys[].id |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].keys[].kty |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].versionId |
number | ||
view.published.enabled |
boolean | ||
view.published.keyAlgorithm |
string | ||
view.published.maxPerPerson |
number | ||
view.subjects |
list | ||
view.subjects[].by |
string | ||
view.subjects[].didDocumentUrl |
string | ||
view.subjects[].didResolved |
boolean | ||
view.subjects[].enrolledAt |
string or number, or null | ||
view.subjects[].label |
string | ||
view.subjects[].location |
object | ||
view.subjects[].location.kind |
string | ||
view.subjects[].location.value |
string | ||
view.subjects[].preferred |
boolean | ||
view.subjects[].proof |
string | ||
view.subjects[].subject |
string | ||
view.turnOn |
object | ||
view.turnOn.administrator |
boolean | ||
view.turnOn.env |
string | ||
view.turnOn.page |
string, or null | ||
view.turnOn.setting |
string |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/self-issued/did
getSelfIssuedDidDocument
The DID document of one of your enrolled did:jwk or did:key subjects
document: the DID document of subject, resolved from the identifier itself — a did:jwk or did:key is its own document, so nothing is published and nothing is fetched. Only a subject enrolled for you: any other is refused (STS-PORTAL-0618), and a did:web (its document is the one published at its address, linked from the list) or a JWK thumbprint (no DID) is refused (STS-PORTAL-0619). With no subject, { subject: '', document: null }.
The door of the portal’s GET /portal/self-issued/did.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
subject |
query | One of your enrolled self-issued subjects: a did:jwk or a did:key. Left out, the page says to choose one. | ||
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
document |
any JSON | A DID document as the DID’s method resolved it (W3C DID Core), or null: its verification methods and services are the DID controller’s to state. A DID document as the DID’s method resolved it (W3C DID Core), or null: its verification methods and services are the DID controller’s to state. | |
ok |
boolean | ||
subject |
string |
400: A did:web or a JWK thumbprint, whose document is not the identifier (STS-PORTAL-0619).
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
404: Not one of your enrolled subjects (STS-PORTAL-0618).
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/self-issued/dids
actOnPublishedDid
Publishes a did:web for you, changes its key, or deactivates it
A did:web this realm publishes for you (#1291), where it does (did.personPublishing). publish: a new DID whose key this realm generates — kept sealed in realm custody, or answered ONCE as view.fresh.file (a private JWK) in download custody and never kept. In wallet custody a DID is published, and its key changed, by proving keys with your wallet at /authn/wallet?siop=1&enrol=1&did_act=…, and this act refuses those (STS-VC-0173). add-key and rotate-key of a realm-custody DID append a version with a newly generated key, beside or instead of the current ones. deactivate ends one: its address answers 410 Gone for good, its history stays resolvable, and it no longer signs you in, nor is it preferred or released. Refusals carry the library’s code (STS-VC-0167 to STS-VC-0176).
The door of the portal’s POST /portal/self-issued/dids.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
action |
one of publish, add-key, rotate-key, deactivate |
yes | publish a DID whose key this realm generates (realm or download custody); add-key or rotate-key of a realm-custody DID; deactivate one of your DIDs. |
rid |
``, or string | The published DID’s random id, from the list; every action but publish names one. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean | ||
stepUp |
object | ||
stepUp.acrValues |
string | ||
stepUp.maxAge |
number | ||
stepUp.prompt |
string | ||
view |
object | ||
view.didClaim |
boolean | ||
view.enabled |
boolean | ||
view.fresh |
object | ||
view.fresh.did |
string | ||
view.fresh.file |
object | ||
view.fresh.file.base64 |
string | ||
view.fresh.file.mime |
string | ||
view.fresh.file.name |
string | ||
view.fresh.kind |
string | ||
view.fresh.rid |
string | ||
view.loginHint |
string | ||
view.notice |
string | ||
view.published |
object | ||
view.published.active |
integer | ||
view.published.canPublish |
boolean | ||
view.published.custody |
string | ||
view.published.dids |
list | ||
view.published.dids[].by |
string, or null | ||
view.published.dids[].createdAt |
string or number, or null | ||
view.published.dids[].currentVersion |
number | ||
view.published.dids[].custody |
string | ||
view.published.dids[].deactivated |
object | ||
view.published.dids[].deactivated.at |
string | ||
view.published.dids[].deactivated.by |
string, or null | ||
view.published.dids[].deactivated.reason |
string, or null | ||
view.published.dids[].did |
string | ||
view.published.dids[].documentUrl |
string | ||
view.published.dids[].pending |
object | ||
view.published.dids[].pending.change |
string | ||
view.published.dids[].pending.expiresAt |
string | ||
view.published.dids[].preferred |
boolean | ||
view.published.dids[].proof |
string | ||
view.published.dids[].rid |
string | ||
view.published.dids[].state |
string | ||
view.published.dids[].versions |
list | ||
view.published.dids[].versions[].authorizedBy |
list | ||
view.published.dids[].versions[].authorizedBy[].actor |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].at |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].keyThumbprint |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].kind |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].subject |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].transaction |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].versionId |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].change |
string | ||
view.published.dids[].versions[].created |
string or number, or null | ||
view.published.dids[].versions[].keys |
list | ||
view.published.dids[].versions[].keys[].alg |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].keys[].crv |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].keys[].id |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].keys[].kty |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].versionId |
number | ||
view.published.enabled |
boolean | ||
view.published.keyAlgorithm |
string | ||
view.published.maxPerPerson |
number | ||
view.subjects |
list | ||
view.subjects[].by |
string | ||
view.subjects[].didDocumentUrl |
string | ||
view.subjects[].didResolved |
boolean | ||
view.subjects[].enrolledAt |
string or number, or null | ||
view.subjects[].label |
string | ||
view.subjects[].location |
object | ||
view.subjects[].location.kind |
string | ||
view.subjects[].location.value |
string | ||
view.subjects[].preferred |
boolean | ||
view.subjects[].proof |
string | ||
view.subjects[].subject |
string | ||
view.turnOn |
object | ||
view.turnOn.administrator |
boolean | ||
view.turnOn.env |
string | ||
view.turnOn.page |
string, or null | ||
view.turnOn.setting |
string |
400: Refused: publishing is off, no pinned base in product mode, the cap, the custody, no such DID, or not stored (STS-VC-0167 to STS-VC-0176).
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.didClaim |
boolean | ||
view.enabled |
boolean | ||
view.fresh |
object | ||
view.fresh.did |
string | ||
view.fresh.file |
object | ||
view.fresh.file.base64 |
string | ||
view.fresh.file.mime |
string | ||
view.fresh.file.name |
string | ||
view.fresh.kind |
string | ||
view.fresh.rid |
string | ||
view.loginHint |
string | ||
view.notice |
string | ||
view.published |
object | ||
view.published.active |
integer | ||
view.published.canPublish |
boolean | ||
view.published.custody |
string | ||
view.published.dids |
list | ||
view.published.dids[].by |
string, or null | ||
view.published.dids[].createdAt |
string or number, or null | ||
view.published.dids[].currentVersion |
number | ||
view.published.dids[].custody |
string | ||
view.published.dids[].deactivated |
object | ||
view.published.dids[].deactivated.at |
string | ||
view.published.dids[].deactivated.by |
string, or null | ||
view.published.dids[].deactivated.reason |
string, or null | ||
view.published.dids[].did |
string | ||
view.published.dids[].documentUrl |
string | ||
view.published.dids[].pending |
object | ||
view.published.dids[].pending.change |
string | ||
view.published.dids[].pending.expiresAt |
string | ||
view.published.dids[].preferred |
boolean | ||
view.published.dids[].proof |
string | ||
view.published.dids[].rid |
string | ||
view.published.dids[].state |
string | ||
view.published.dids[].versions |
list | ||
view.published.dids[].versions[].authorizedBy |
list | ||
view.published.dids[].versions[].authorizedBy[].actor |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].at |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].keyThumbprint |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].kind |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].subject |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].transaction |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].authorizedBy[].versionId |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].change |
string | ||
view.published.dids[].versions[].created |
string or number, or null | ||
view.published.dids[].versions[].keys |
list | ||
view.published.dids[].versions[].keys[].alg |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].keys[].crv |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].keys[].id |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].keys[].kty |
object | Nested deeper than this page draws. | |
view.published.dids[].versions[].versionId |
number | ||
view.published.enabled |
boolean | ||
view.published.keyAlgorithm |
string | ||
view.published.maxPerPerson |
number | ||
view.subjects |
list | ||
view.subjects[].by |
string | ||
view.subjects[].didDocumentUrl |
string | ||
view.subjects[].didResolved |
boolean | ||
view.subjects[].enrolledAt |
string or number, or null | ||
view.subjects[].label |
string | ||
view.subjects[].location |
object | ||
view.subjects[].location.kind |
string | ||
view.subjects[].location.value |
string | ||
view.subjects[].preferred |
boolean | ||
view.subjects[].proof |
string | ||
view.subjects[].subject |
string | ||
view.turnOn |
object | ||
view.turnOn.administrator |
boolean | ||
view.turnOn.env |
string | ||
view.turnOn.page |
string, or null | ||
view.turnOn.setting |
string |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/shared
getShared
What you share through User-Managed Access
One page (paging) of resources: the resources resource servers registered on your behalf, each with its scopes and the shares your sharing policy holds for it; the custom rules of your policy the share form did not write, with their ALFA; the pending requests waiting for your approval; and, where the realm allows it (alfaEditing), your whole policy as alfa. enabled says whether UMA is on.
The door of the portal’s GET /portal/shared.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
page |
query | |||
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
alfa |
string | ||
alfaEditing |
boolean | ||
custom |
list | ||
custom[].alfa |
string | ||
custom[].description |
string | ||
custom[].id |
string | ||
enabled |
boolean | ||
ok |
boolean | ||
paging |
object | ||
paging.page |
integer | ||
paging.pages |
integer | ||
paging.total |
integer | ||
pending |
list | ||
pending[].client |
string | ||
pending[].expiresAt |
number | ||
pending[].id |
string | ||
pending[].permissions |
list | ||
pending[].permissions[].resource_id |
string | ||
pending[].permissions[].resource_scopes |
list | ||
pending[].permissions[].resource_scopes[] |
string | ||
pending[].requestingParty |
string | ||
recipients |
list | ||
recipients[] |
string | ||
resources |
list | ||
resources[].id |
string | ||
resources[].name |
string | ||
resources[].resourceServer |
string | ||
resources[].scopes |
list | ||
resources[].scopes[] |
string | ||
resources[].shares |
list | ||
resources[].shares[].acr |
string | ||
resources[].shares[].askMe |
boolean | ||
resources[].shares[].expires |
string | ||
resources[].shares[].id |
string | ||
resources[].shares[].recipient |
object | ||
resources[].shares[].recipient.claim |
string | ||
resources[].shares[].recipient.kind |
string | ||
resources[].shares[].recipient.label |
string | ||
resources[].shares[].recipient.value |
string | ||
resources[].shares[].resourceId |
string | ||
resources[].shares[].scopes |
list | ||
resources[].shares[].scopes[] |
string | ||
resources[].type |
string | ||
version |
string or number, or null |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/shared
actShared
Shares a resource, removes a share, or rewrites your policy
action share writes one rule into your sharing policy: a resource of yours, its scopes, and who — a person, a group, anyone signed in to this realm, or anyone whose claim has a value — with an optional expiry, authentication level and “ask me each time”. approve and refuse answer a request waiting for you; an approval adds a share for that person for a day. unshare removes one and revokes the requesting party tokens that carried it. alfa replaces the whole policy, where the realm allows it, and revokes every token over your resources. A resource or share that is not yours is refused.
The door of the portal’s POST /portal/shared.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
acr |
``, or string | share: an optional authentication level the requesting party’s session must meet. | |
action |
one of share, unshare, alfa, approve, refuse |
yes | share adds a share; unshare removes one; alfa replaces the whole document, where the realm allows it; approve and refuse answer a request waiting for you. |
alfa |
``, or string | alfa: the whole document, as ALFA. | |
askMe |
``, or one of 0, 1, true, false, on, off, yes, no |
share: ask the owner each time. | |
claim |
``, or string | share, recipientKind claim: the claim’s name. | |
expires |
``, or string | share: an optional date the share ends. | |
page |
``, or integer | The page of the list the form was on. | |
pending |
``, or string | approve, refuse: the waiting request’s id, from the list. | |
recipient |
``, or string | share: the username, the group’s name, or the claim’s value. | |
recipientKind |
``, or one of person, group, realm, claim |
share: who the share is with. | |
resource |
``, or string | share: the resource’s _id, one of yours. | |
scope |
list, or ``, or string | ||
scope[] |
string | ||
share |
``, or string | unshare: the share’s id, from the list. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean | ||
view |
object | ||
view.alfa |
string | ||
view.alfaEditing |
boolean | ||
view.custom |
list | ||
view.custom[].alfa |
string | ||
view.custom[].description |
string | ||
view.custom[].id |
string | ||
view.enabled |
boolean | ||
view.ok |
boolean | ||
view.paging |
object | ||
view.paging.page |
integer | ||
view.paging.pages |
integer | ||
view.paging.total |
integer | ||
view.pending |
list | ||
view.pending[].client |
string | ||
view.pending[].expiresAt |
number | ||
view.pending[].id |
string | ||
view.pending[].permissions |
list | ||
view.pending[].permissions[].resource_id |
string | ||
view.pending[].permissions[].resource_scopes |
list | ||
view.pending[].permissions[].resource_scopes[] |
string | ||
view.pending[].requestingParty |
string | ||
view.recipients |
list | ||
view.recipients[] |
string | ||
view.resources |
list | ||
view.resources[].id |
string | ||
view.resources[].name |
string | ||
view.resources[].resourceServer |
string | ||
view.resources[].scopes |
list | ||
view.resources[].scopes[] |
string | ||
view.resources[].shares |
list | ||
view.resources[].shares[].acr |
string | ||
view.resources[].shares[].askMe |
boolean | ||
view.resources[].shares[].expires |
string | ||
view.resources[].shares[].id |
string | ||
view.resources[].shares[].recipient |
object | ||
view.resources[].shares[].recipient.claim |
string | ||
view.resources[].shares[].recipient.kind |
string | ||
view.resources[].shares[].recipient.label |
string | ||
view.resources[].shares[].recipient.value |
string | ||
view.resources[].shares[].resourceId |
string | ||
view.resources[].shares[].scopes |
list | ||
view.resources[].shares[].scopes[] |
string | ||
view.resources[].type |
string | ||
view.version |
string or number, or null |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.alfa |
string | ||
view.alfaEditing |
boolean | ||
view.custom |
list | ||
view.custom[].alfa |
string | ||
view.custom[].description |
string | ||
view.custom[].id |
string | ||
view.enabled |
boolean | ||
view.ok |
boolean | ||
view.paging |
object | ||
view.paging.page |
integer | ||
view.paging.pages |
integer | ||
view.paging.total |
integer | ||
view.pending |
list | ||
view.pending[].client |
string | ||
view.pending[].expiresAt |
number | ||
view.pending[].id |
string | ||
view.pending[].permissions |
list | ||
view.pending[].permissions[].resource_id |
string | ||
view.pending[].permissions[].resource_scopes |
list | ||
view.pending[].permissions[].resource_scopes[] |
string | ||
view.pending[].requestingParty |
string | ||
view.recipients |
list | ||
view.recipients[] |
string | ||
view.resources |
list | ||
view.resources[].id |
string | ||
view.resources[].name |
string | ||
view.resources[].resourceServer |
string | ||
view.resources[].scopes |
list | ||
view.resources[].scopes[] |
string | ||
view.resources[].shares |
list | ||
view.resources[].shares[].acr |
string | ||
view.resources[].shares[].askMe |
boolean | ||
view.resources[].shares[].expires |
string | ||
view.resources[].shares[].id |
string | ||
view.resources[].shares[].recipient |
object | ||
view.resources[].shares[].recipient.claim |
string | ||
view.resources[].shares[].recipient.kind |
string | ||
view.resources[].shares[].recipient.label |
string | ||
view.resources[].shares[].recipient.value |
string | ||
view.resources[].shares[].resourceId |
string | ||
view.resources[].shares[].scopes |
list | ||
view.resources[].shares[].scopes[] |
string | ||
view.resources[].type |
string | ||
view.version |
string or number, or null |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.alfa |
string | ||
view.alfaEditing |
boolean | ||
view.custom |
list | ||
view.custom[].alfa |
string | ||
view.custom[].description |
string | ||
view.custom[].id |
string | ||
view.enabled |
boolean | ||
view.ok |
boolean | ||
view.paging |
object | ||
view.paging.page |
integer | ||
view.paging.pages |
integer | ||
view.paging.total |
integer | ||
view.pending |
list | ||
view.pending[].client |
string | ||
view.pending[].expiresAt |
number | ||
view.pending[].id |
string | ||
view.pending[].permissions |
list | ||
view.pending[].permissions[].resource_id |
string | ||
view.pending[].permissions[].resource_scopes |
list | ||
view.pending[].permissions[].resource_scopes[] |
string | ||
view.pending[].requestingParty |
string | ||
view.recipients |
list | ||
view.recipients[] |
string | ||
view.resources |
list | ||
view.resources[].id |
string | ||
view.resources[].name |
string | ||
view.resources[].resourceServer |
string | ||
view.resources[].scopes |
list | ||
view.resources[].scopes[] |
string | ||
view.resources[].shares |
list | ||
view.resources[].shares[].acr |
string | ||
view.resources[].shares[].askMe |
boolean | ||
view.resources[].shares[].expires |
string | ||
view.resources[].shares[].id |
string | ||
view.resources[].shares[].recipient |
object | ||
view.resources[].shares[].recipient.claim |
string | ||
view.resources[].shares[].recipient.kind |
string | ||
view.resources[].shares[].recipient.label |
string | ||
view.resources[].shares[].recipient.value |
string | ||
view.resources[].shares[].resourceId |
string | ||
view.resources[].shares[].scopes |
list | ||
view.resources[].shares[].scopes[] |
string | ||
view.resources[].type |
string | ||
view.version |
string or number, or null |
500: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.alfa |
string | ||
view.alfaEditing |
boolean | ||
view.custom |
list | ||
view.custom[].alfa |
string | ||
view.custom[].description |
string | ||
view.custom[].id |
string | ||
view.enabled |
boolean | ||
view.ok |
boolean | ||
view.paging |
object | ||
view.paging.page |
integer | ||
view.paging.pages |
integer | ||
view.paging.total |
integer | ||
view.pending |
list | ||
view.pending[].client |
string | ||
view.pending[].expiresAt |
number | ||
view.pending[].id |
string | ||
view.pending[].permissions |
list | ||
view.pending[].permissions[].resource_id |
string | ||
view.pending[].permissions[].resource_scopes |
list | ||
view.pending[].permissions[].resource_scopes[] |
string | ||
view.pending[].requestingParty |
string | ||
view.recipients |
list | ||
view.recipients[] |
string | ||
view.resources |
list | ||
view.resources[].id |
string | ||
view.resources[].name |
string | ||
view.resources[].resourceServer |
string | ||
view.resources[].scopes |
list | ||
view.resources[].scopes[] |
string | ||
view.resources[].shares |
list | ||
view.resources[].shares[].acr |
string | ||
view.resources[].shares[].askMe |
boolean | ||
view.resources[].shares[].expires |
string | ||
view.resources[].shares[].id |
string | ||
view.resources[].shares[].recipient |
object | ||
view.resources[].shares[].recipient.claim |
string | ||
view.resources[].shares[].recipient.kind |
string | ||
view.resources[].shares[].recipient.label |
string | ||
view.resources[].shares[].recipient.value |
string | ||
view.resources[].shares[].resourceId |
string | ||
view.resources[].shares[].scopes |
list | ||
view.resources[].shares[].scopes[] |
string | ||
view.resources[].type |
string | ||
view.version |
string or number, or null |
GET /account-api/shared-with-me
getSharedWithMe
What others share with you
One page (paging) of rows: each permission a requesting party token issued to you carries — the resource, its resource server and owner, the scopes, the client that holds the token, and until when.
The door of the portal’s GET /portal/shared-with-me.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
page |
query | |||
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
ok |
boolean | ||
paging |
object | ||
paging.page |
integer | ||
paging.pages |
integer | ||
paging.total |
integer | ||
rows |
list | ||
rows[].client |
string | ||
rows[].expiresAt |
number | ||
rows[].name |
string | ||
rows[].owner |
string | ||
rows[].resourceId |
string | ||
rows[].resourceServer |
string | ||
rows[].scopes |
list | ||
rows[].scopes[] |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/sign-ins
getSignIns
Your assessed sign-ins, with the application of each
One page (paging, moved by page, newest first) of the assessments of your sign-ins: when, the city, country and network, the browser and system, the door, the application (the client the sign-in named), the risk level, and your answer if you gave one. days is how far back the list looks (audit.authenticationHistoryDays, thirty by default, set per realm). paging.total counts every sign-in of that window. thisSession is the assessment of the session this token was issued on.
The door of the portal’s GET /portal/sign-ins.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
page |
query | Which page of rows, newest first. Clamped to the last. |
||
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
days |
number | ||
paging |
object | ||
paging.page |
integer | ||
paging.pages |
integer | ||
paging.per |
integer | ||
paging.total |
integer | ||
rows |
list | ||
rows[].addressPrefix |
string | ||
rows[].application |
string | ||
rows[].asOrg |
string | ||
rows[].at |
string or number, or null | ||
rows[].city |
string | ||
rows[].country |
string | ||
rows[].door |
string | ||
rows[].feedback |
string | ||
rows[].id |
string or number | ||
rows[].level |
string | ||
rows[].uaFamily |
string | ||
rows[].uaOs |
string | ||
thisSession |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/sign-ins
answerSignIn
Says whether a sign-in was you
confirm is recorded, and lowers your standing only when said from another, low-risk session. deny puts your standing at HIGH: everything you hold is ended, this session included, and RISC is told the credential is compromised (ended: true).
The door of the portal’s POST /portal/sign-ins.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
action |
one of confirm, deny |
yes | confirm: this was me. deny: this was not me. |
assessment |
string | yes | The assessment’s id, from the list. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
ended |
boolean | ||
go |
string | ||
message |
string | ||
ok |
boolean | ||
view |
object | ||
view.days |
number | ||
view.paging |
object | ||
view.paging.page |
integer | ||
view.paging.pages |
integer | ||
view.paging.per |
integer | ||
view.paging.total |
integer | ||
view.rows |
list | ||
view.rows[].addressPrefix |
string | ||
view.rows[].application |
string | ||
view.rows[].asOrg |
string | ||
view.rows[].at |
string or number, or null | ||
view.rows[].city |
string | ||
view.rows[].country |
string | ||
view.rows[].door |
string | ||
view.rows[].feedback |
string | ||
view.rows[].id |
string or number | ||
view.rows[].level |
string | ||
view.rows[].uaFamily |
string | ||
view.rows[].uaOs |
string | ||
view.thisSession |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/signals
getSecurityActivity
The security events this portal was told about you
The CAEP and RISC events this portal received as a Shared Signals receiver that are about you (an event it cannot tie to you is left out), twenty to a page, each with whether its signature verified and what this portal did with it; and whether events about your account are shared (RISC section 2.8, participation, null while RISC is off).
The door of the portal’s GET /portal/signals.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
done |
query | string | ||
page |
query | The page of the list, 1 for the first. | ||
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
incomplete |
boolean | ||
page |
integer | ||
pages |
integer | ||
participation |
object | ||
participation.applies |
boolean | ||
participation.hours |
number | ||
participation.moves |
list | ||
participation.moves[] |
string | ||
participation.since |
string | ||
participation.state |
string | ||
participation.why |
string | ||
rows |
list | ||
rows[].at |
string or number, or null | ||
rows[].name |
string | ||
rows[].payload |
any JSON | The event’s payload as a transmitter signed it: CAEP and RISC events carry members by event type, and an unknown type is shown as it came. The event’s payload as a transmitter signed it: CAEP and RISC events carry members by event type, and an unknown type is shown as it came. | |
rows[].reactions |
list | ||
rows[].reactions[].ended |
number | ||
rows[].reactions[].failed |
boolean | ||
rows[].reactions[].observed |
boolean | ||
rows[].reactions[].skipped |
string | ||
rows[].type |
string | ||
rows[].verificationNote |
string | ||
rows[].verified |
boolean | ||
rows[].vocabulary |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/signals
moveRiscParticipation
Stops, cancels stopping, or resumes sharing security events about you
RISC 1.0 section 2.8’s account-holder moves. Opting out takes effect only after risc.optOutDelayHours, and can be cancelled until then.
The door of the portal’s POST /portal/signals.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
move |
one of optOutInitiated, optOutCancelled, optIn |
The move: start opting out, cancel that, or opt back in. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
409: That move is not one your account can make now.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
503: Shared Signals is off, so nothing was recorded.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
GET /account-api/signing-key
getSigningKeys
Your signing key pairs and TLS client certificates
profiles: RFC 7523’s JWT and RFC 7522’s SAML key pairs — for each, held.keys (every key pair you hold, newest first: its handle — kid or thumbprint —, label, state, expiry and certificate), the issuers you may assert as, and atCap (you hold maxPerPerson valid ones, pki.personSigningKeyMax). tls: your TLS client certificates, where one signs you in, and what the form offers. offered (pki.personSelfService) and issuable (a certificate authority exists) say whether you may generate. No private key is ever in this answer.
The door of the portal’s GET /portal/signing-key.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
entry |
boolean | ||
fresh |
object | ||
fresh.files |
object | ||
fresh.files.chain |
object | ||
fresh.files.chain.base64 |
string | ||
fresh.files.chain.mime |
string | ||
fresh.files.chain.name |
string | ||
fresh.files.key |
object | ||
fresh.files.key.base64 |
string | ||
fresh.files.key.mime |
string | ||
fresh.files.key.name |
string | ||
fresh.handle |
string | ||
fresh.issued |
object | ||
fresh.issued.keyAlg |
string | ||
fresh.issued.notAfter |
string | ||
fresh.issued.serialHex |
string | ||
fresh.issued.subject |
string | ||
fresh.issuer |
string | ||
fresh.jwsAlg |
string | ||
fresh.kid |
string | ||
fresh.kind |
string | ||
fresh.label |
string | ||
fresh.purpose |
string | ||
fresh.thumbprint |
string | ||
holdsAny |
boolean | ||
issuable |
boolean | ||
maxPerPerson |
number | ||
offered |
boolean | ||
profiles |
list | ||
profiles[].atCap |
boolean | ||
profiles[].grantType |
string | ||
profiles[].held |
object | ||
profiles[].held.issuers |
list | ||
profiles[].held.issuers[] |
string | ||
profiles[].held.keys |
list | ||
profiles[].held.keys[].certificate |
string | ||
profiles[].held.keys[].expiresAt |
string | ||
profiles[].held.keys[].handle |
string | ||
profiles[].held.keys[].keyAlg |
string | ||
profiles[].held.keys[].label |
string | ||
profiles[].held.keys[].notAfter |
string | ||
profiles[].held.keys[].reason |
string | ||
profiles[].held.keys[].revokedAt |
string | ||
profiles[].held.keys[].serialHex |
string | ||
profiles[].held.keys[].source |
string | ||
profiles[].held.keys[].state |
string | ||
profiles[].held.valid |
integer | ||
profiles[].id |
string | ||
profiles[].rfc |
string | ||
reasons |
list | ||
reasons[] |
string | ||
tls |
object | ||
tls.defaultKeyAlg |
string, or null | ||
tls.held |
list | ||
tls.held[].keyAlg |
string | ||
tls.held[].label |
string | ||
tls.held[].notAfter |
string | ||
tls.held[].reason |
string | ||
tls.held[].revokedAt |
string | ||
tls.held[].serialHex |
string | ||
tls.held[].state |
string | ||
tls.keyAlgs |
list | ||
tls.keyAlgs[] |
string | ||
tls.maxPerPerson |
number | ||
tls.note |
string | ||
tls.signIn |
string | ||
tls.trusted |
boolean | ||
tokenEndpoint |
string | ||
username |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
POST /account-api/signing-key
changeSigningKeys
Generates or revokes a signing key or TLS certificate
generate ADDS a key pair for purpose from this realm’s Issuing CA, named by label (refused at the cap); revoke revokes one of yours by handle, with reason: its certificate goes on the CRL and the key stops being accepted. generate-tls-client issues a TLS client certificate; revoke-tls-client revokes one of yours. Both generations answer the private key (unencrypted PKCS#8 PEM) and the certificate chain ONCE, in view.fresh.files.key and view.fresh.files.chain (base64). Both generations are refused (403) where self-service is off, and rate limited. A refusal carries the page’s view.
The door of the portal’s POST /portal/signing-key.
Scope: account:manage.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
action |
``, or one of generate, revoke, generate-tls-client, revoke-tls-client |
generate a signing key pair (for purpose) or revoke one of yours (by handle); generate-tls-client or revoke-tls-client a TLS client certificate. |
|
handle |
string | For revoke: the key pair’s kid (RFC 7523) or certificate thumbprint (RFC 7522), one of yours. |
|
key_alg |
``, or one of rsa-2048, rsa-3072, ec-p256, ec-p384 |
For generate-tls-client: the key algorithm. |
|
label |
string | For generate: what you call the key pair. For generate-tls-client: what you call the device. |
|
purpose |
``, or one of jwt, saml |
For generate and revoke: RFC 7523’s jwt key pairs (the default) or RFC 7522’s saml ones. |
|
reason |
``, or one of cessationOfOperation, keyCompromise |
For revoke and revoke-tls-client: why. |
|
serial |
string | For revoke-tls-client: the certificate’s serial, one of yours. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean | ||
stepUp |
object | ||
stepUp.acrValues |
string | ||
stepUp.maxAge |
number | ||
stepUp.prompt |
string | ||
view |
object | ||
view.entry |
boolean | ||
view.fresh |
object | ||
view.fresh.files |
object | ||
view.fresh.files.chain |
object | ||
view.fresh.files.chain.base64 |
string | ||
view.fresh.files.chain.mime |
string | ||
view.fresh.files.chain.name |
string | ||
view.fresh.files.key |
object | ||
view.fresh.files.key.base64 |
string | ||
view.fresh.files.key.mime |
string | ||
view.fresh.files.key.name |
string | ||
view.fresh.handle |
string | ||
view.fresh.issued |
object | ||
view.fresh.issued.keyAlg |
string | ||
view.fresh.issued.notAfter |
string | ||
view.fresh.issued.serialHex |
string | ||
view.fresh.issued.subject |
string | ||
view.fresh.issuer |
string | ||
view.fresh.jwsAlg |
string | ||
view.fresh.kid |
string | ||
view.fresh.kind |
string | ||
view.fresh.label |
string | ||
view.fresh.purpose |
string | ||
view.fresh.thumbprint |
string | ||
view.holdsAny |
boolean | ||
view.issuable |
boolean | ||
view.maxPerPerson |
number | ||
view.offered |
boolean | ||
view.profiles |
list | ||
view.profiles[].atCap |
boolean | ||
view.profiles[].grantType |
string | ||
view.profiles[].held |
object | ||
view.profiles[].held.issuers |
list | ||
view.profiles[].held.issuers[] |
string | ||
view.profiles[].held.keys |
list | ||
view.profiles[].held.keys[].certificate |
string | ||
view.profiles[].held.keys[].expiresAt |
string | ||
view.profiles[].held.keys[].handle |
string | ||
view.profiles[].held.keys[].keyAlg |
string | ||
view.profiles[].held.keys[].label |
string | ||
view.profiles[].held.keys[].notAfter |
string | ||
view.profiles[].held.keys[].reason |
string | ||
view.profiles[].held.keys[].revokedAt |
string | ||
view.profiles[].held.keys[].serialHex |
string | ||
view.profiles[].held.keys[].source |
string | ||
view.profiles[].held.keys[].state |
string | ||
view.profiles[].held.valid |
integer | ||
view.profiles[].id |
string | ||
view.profiles[].rfc |
string | ||
view.reasons |
list | ||
view.reasons[] |
string | ||
view.tls |
object | ||
view.tls.defaultKeyAlg |
string, or null | ||
view.tls.held |
list | ||
view.tls.held[].keyAlg |
string | ||
view.tls.held[].label |
string | ||
view.tls.held[].notAfter |
string | ||
view.tls.held[].reason |
string | ||
view.tls.held[].revokedAt |
string | ||
view.tls.held[].serialHex |
string | ||
view.tls.held[].state |
string | ||
view.tls.keyAlgs |
list | ||
view.tls.keyAlgs[] |
string | ||
view.tls.maxPerPerson |
number | ||
view.tls.note |
string | ||
view.tls.signIn |
string | ||
view.tls.trusted |
boolean | ||
view.tokenEndpoint |
string | ||
view.username |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.entry |
boolean | ||
view.fresh |
object | ||
view.fresh.files |
object | ||
view.fresh.files.chain |
object | ||
view.fresh.files.chain.base64 |
string | ||
view.fresh.files.chain.mime |
string | ||
view.fresh.files.chain.name |
string | ||
view.fresh.files.key |
object | ||
view.fresh.files.key.base64 |
string | ||
view.fresh.files.key.mime |
string | ||
view.fresh.files.key.name |
string | ||
view.fresh.handle |
string | ||
view.fresh.issued |
object | ||
view.fresh.issued.keyAlg |
string | ||
view.fresh.issued.notAfter |
string | ||
view.fresh.issued.serialHex |
string | ||
view.fresh.issued.subject |
string | ||
view.fresh.issuer |
string | ||
view.fresh.jwsAlg |
string | ||
view.fresh.kid |
string | ||
view.fresh.kind |
string | ||
view.fresh.label |
string | ||
view.fresh.purpose |
string | ||
view.fresh.thumbprint |
string | ||
view.holdsAny |
boolean | ||
view.issuable |
boolean | ||
view.maxPerPerson |
number | ||
view.offered |
boolean | ||
view.profiles |
list | ||
view.profiles[].atCap |
boolean | ||
view.profiles[].grantType |
string | ||
view.profiles[].held |
object | ||
view.profiles[].held.issuers |
list | ||
view.profiles[].held.issuers[] |
string | ||
view.profiles[].held.keys |
list | ||
view.profiles[].held.keys[].certificate |
string | ||
view.profiles[].held.keys[].expiresAt |
string | ||
view.profiles[].held.keys[].handle |
string | ||
view.profiles[].held.keys[].keyAlg |
string | ||
view.profiles[].held.keys[].label |
string | ||
view.profiles[].held.keys[].notAfter |
string | ||
view.profiles[].held.keys[].reason |
string | ||
view.profiles[].held.keys[].revokedAt |
string | ||
view.profiles[].held.keys[].serialHex |
string | ||
view.profiles[].held.keys[].source |
string | ||
view.profiles[].held.keys[].state |
string | ||
view.profiles[].held.valid |
integer | ||
view.profiles[].id |
string | ||
view.profiles[].rfc |
string | ||
view.reasons |
list | ||
view.reasons[] |
string | ||
view.tls |
object | ||
view.tls.defaultKeyAlg |
string, or null | ||
view.tls.held |
list | ||
view.tls.held[].keyAlg |
string | ||
view.tls.held[].label |
string | ||
view.tls.held[].notAfter |
string | ||
view.tls.held[].reason |
string | ||
view.tls.held[].revokedAt |
string | ||
view.tls.held[].serialHex |
string | ||
view.tls.held[].state |
string | ||
view.tls.keyAlgs |
list | ||
view.tls.keyAlgs[] |
string | ||
view.tls.maxPerPerson |
number | ||
view.tls.note |
string | ||
view.tls.signIn |
string | ||
view.tls.trusted |
boolean | ||
view.tokenEndpoint |
string | ||
view.username |
string |
401: No access token, or one that does not verify, has expired, was revoked, outlived its sign-on session, or came without its DPoP proof. WWW-Authenticate says which.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean |
403: The token is for another audience or does not carry account:manage, or the access policy refused the person.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.entry |
boolean | ||
view.fresh |
object | ||
view.fresh.files |
object | ||
view.fresh.files.chain |
object | ||
view.fresh.files.chain.base64 |
string | ||
view.fresh.files.chain.mime |
string | ||
view.fresh.files.chain.name |
string | ||
view.fresh.files.key |
object | ||
view.fresh.files.key.base64 |
string | ||
view.fresh.files.key.mime |
string | ||
view.fresh.files.key.name |
string | ||
view.fresh.handle |
string | ||
view.fresh.issued |
object | ||
view.fresh.issued.keyAlg |
string | ||
view.fresh.issued.notAfter |
string | ||
view.fresh.issued.serialHex |
string | ||
view.fresh.issued.subject |
string | ||
view.fresh.issuer |
string | ||
view.fresh.jwsAlg |
string | ||
view.fresh.kid |
string | ||
view.fresh.kind |
string | ||
view.fresh.label |
string | ||
view.fresh.purpose |
string | ||
view.fresh.thumbprint |
string | ||
view.holdsAny |
boolean | ||
view.issuable |
boolean | ||
view.maxPerPerson |
number | ||
view.offered |
boolean | ||
view.profiles |
list | ||
view.profiles[].atCap |
boolean | ||
view.profiles[].grantType |
string | ||
view.profiles[].held |
object | ||
view.profiles[].held.issuers |
list | ||
view.profiles[].held.issuers[] |
string | ||
view.profiles[].held.keys |
list | ||
view.profiles[].held.keys[].certificate |
string | ||
view.profiles[].held.keys[].expiresAt |
string | ||
view.profiles[].held.keys[].handle |
string | ||
view.profiles[].held.keys[].keyAlg |
string | ||
view.profiles[].held.keys[].label |
string | ||
view.profiles[].held.keys[].notAfter |
string | ||
view.profiles[].held.keys[].reason |
string | ||
view.profiles[].held.keys[].revokedAt |
string | ||
view.profiles[].held.keys[].serialHex |
string | ||
view.profiles[].held.keys[].source |
string | ||
view.profiles[].held.keys[].state |
string | ||
view.profiles[].held.valid |
integer | ||
view.profiles[].id |
string | ||
view.profiles[].rfc |
string | ||
view.reasons |
list | ||
view.reasons[] |
string | ||
view.tls |
object | ||
view.tls.defaultKeyAlg |
string, or null | ||
view.tls.held |
list | ||
view.tls.held[].keyAlg |
string | ||
view.tls.held[].label |
string | ||
view.tls.held[].notAfter |
string | ||
view.tls.held[].reason |
string | ||
view.tls.held[].revokedAt |
string | ||
view.tls.held[].serialHex |
string | ||
view.tls.held[].state |
string | ||
view.tls.keyAlgs |
list | ||
view.tls.keyAlgs[] |
string | ||
view.tls.maxPerPerson |
number | ||
view.tls.note |
string | ||
view.tls.signIn |
string | ||
view.tls.trusted |
boolean | ||
view.tokenEndpoint |
string | ||
view.username |
string |
429: Too many generations; try again later.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.entry |
boolean | ||
view.fresh |
object | ||
view.fresh.files |
object | ||
view.fresh.files.chain |
object | ||
view.fresh.files.chain.base64 |
string | ||
view.fresh.files.chain.mime |
string | ||
view.fresh.files.chain.name |
string | ||
view.fresh.files.key |
object | ||
view.fresh.files.key.base64 |
string | ||
view.fresh.files.key.mime |
string | ||
view.fresh.files.key.name |
string | ||
view.fresh.handle |
string | ||
view.fresh.issued |
object | ||
view.fresh.issued.keyAlg |
string | ||
view.fresh.issued.notAfter |
string | ||
view.fresh.issued.serialHex |
string | ||
view.fresh.issued.subject |
string | ||
view.fresh.issuer |
string | ||
view.fresh.jwsAlg |
string | ||
view.fresh.kid |
string | ||
view.fresh.kind |
string | ||
view.fresh.label |
string | ||
view.fresh.purpose |
string | ||
view.fresh.thumbprint |
string | ||
view.holdsAny |
boolean | ||
view.issuable |
boolean | ||
view.maxPerPerson |
number | ||
view.offered |
boolean | ||
view.profiles |
list | ||
view.profiles[].atCap |
boolean | ||
view.profiles[].grantType |
string | ||
view.profiles[].held |
object | ||
view.profiles[].held.issuers |
list | ||
view.profiles[].held.issuers[] |
string | ||
view.profiles[].held.keys |
list | ||
view.profiles[].held.keys[].certificate |
string | ||
view.profiles[].held.keys[].expiresAt |
string | ||
view.profiles[].held.keys[].handle |
string | ||
view.profiles[].held.keys[].keyAlg |
string | ||
view.profiles[].held.keys[].label |
string | ||
view.profiles[].held.keys[].notAfter |
string | ||
view.profiles[].held.keys[].reason |
string | ||
view.profiles[].held.keys[].revokedAt |
string | ||
view.profiles[].held.keys[].serialHex |
string | ||
view.profiles[].held.keys[].source |
string | ||
view.profiles[].held.keys[].state |
string | ||
view.profiles[].held.valid |
integer | ||
view.profiles[].id |
string | ||
view.profiles[].rfc |
string | ||
view.reasons |
list | ||
view.reasons[] |
string | ||
view.tls |
object | ||
view.tls.defaultKeyAlg |
string, or null | ||
view.tls.held |
list | ||
view.tls.held[].keyAlg |
string | ||
view.tls.held[].label |
string | ||
view.tls.held[].notAfter |
string | ||
view.tls.held[].reason |
string | ||
view.tls.held[].revokedAt |
string | ||
view.tls.held[].serialHex |
string | ||
view.tls.held[].state |
string | ||
view.tls.keyAlgs |
list | ||
view.tls.keyAlgs[] |
string | ||
view.tls.maxPerPerson |
number | ||
view.tls.note |
string | ||
view.tls.signIn |
string | ||
view.tls.trusted |
boolean | ||
view.tokenEndpoint |
string | ||
view.username |
string |
500: Issued and then lost; nothing usable was kept.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.entry |
boolean | ||
view.fresh |
object | ||
view.fresh.files |
object | ||
view.fresh.files.chain |
object | ||
view.fresh.files.chain.base64 |
string | ||
view.fresh.files.chain.mime |
string | ||
view.fresh.files.chain.name |
string | ||
view.fresh.files.key |
object | ||
view.fresh.files.key.base64 |
string | ||
view.fresh.files.key.mime |
string | ||
view.fresh.files.key.name |
string | ||
view.fresh.handle |
string | ||
view.fresh.issued |
object | ||
view.fresh.issued.keyAlg |
string | ||
view.fresh.issued.notAfter |
string | ||
view.fresh.issued.serialHex |
string | ||
view.fresh.issued.subject |
string | ||
view.fresh.issuer |
string | ||
view.fresh.jwsAlg |
string | ||
view.fresh.kid |
string | ||
view.fresh.kind |
string | ||
view.fresh.label |
string | ||
view.fresh.purpose |
string | ||
view.fresh.thumbprint |
string | ||
view.holdsAny |
boolean | ||
view.issuable |
boolean | ||
view.maxPerPerson |
number | ||
view.offered |
boolean | ||
view.profiles |
list | ||
view.profiles[].atCap |
boolean | ||
view.profiles[].grantType |
string | ||
view.profiles[].held |
object | ||
view.profiles[].held.issuers |
list | ||
view.profiles[].held.issuers[] |
string | ||
view.profiles[].held.keys |
list | ||
view.profiles[].held.keys[].certificate |
string | ||
view.profiles[].held.keys[].expiresAt |
string | ||
view.profiles[].held.keys[].handle |
string | ||
view.profiles[].held.keys[].keyAlg |
string | ||
view.profiles[].held.keys[].label |
string | ||
view.profiles[].held.keys[].notAfter |
string | ||
view.profiles[].held.keys[].reason |
string | ||
view.profiles[].held.keys[].revokedAt |
string | ||
view.profiles[].held.keys[].serialHex |
string | ||
view.profiles[].held.keys[].source |
string | ||
view.profiles[].held.keys[].state |
string | ||
view.profiles[].held.valid |
integer | ||
view.profiles[].id |
string | ||
view.profiles[].rfc |
string | ||
view.reasons |
list | ||
view.reasons[] |
string | ||
view.tls |
object | ||
view.tls.defaultKeyAlg |
string, or null | ||
view.tls.held |
list | ||
view.tls.held[].keyAlg |
string | ||
view.tls.held[].label |
string | ||
view.tls.held[].notAfter |
string | ||
view.tls.held[].reason |
string | ||
view.tls.held[].revokedAt |
string | ||
view.tls.held[].serialHex |
string | ||
view.tls.held[].state |
string | ||
view.tls.keyAlgs |
list | ||
view.tls.keyAlgs[] |
string | ||
view.tls.maxPerPerson |
number | ||
view.tls.note |
string | ||
view.tls.signIn |
string | ||
view.tls.trusted |
boolean | ||
view.tokenEndpoint |
string | ||
view.username |
string |
GET /account-api/verify-email
getEmailVerification
Checks an address verification link, and spends nothing
Takes no token: the link’s user and token are the credential. Answers the address the link would verify, or view.refused. Opening it spends nothing, so a mail scanner cannot verify an address nobody read. Rate limited.
The door of the portal’s GET /portal/verify-email.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
user |
query | The username the link names. | ||
X-Link-Token |
header | string | The single-use secret the link carried in its fragment. | |
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
address |
string | ||
token |
string | ||
username |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.refused |
string |
429: Too many attempts; view.refused says so.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.refused |
string |
POST /account-api/verify-email
verifyEmail
Verifies the address an address verification link names
Spends the link. Answers view.verified, or view.refused. Rate limited.
The door of the portal’s POST /portal/verify-email.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
token |
``, or string | The link’s single-use secret. | |
user |
``, or string | The username the link names. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean | ||
view |
object | ||
view.address |
string | ||
view.username |
string | ||
view.verified |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.refused |
string |
429: Too many attempts; view.refused says so.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.refused |
string |
GET /account-api/verify-pseudonym
getPseudonymVerification
Checks a sign-in-name link, and spends nothing
Takes no token: the link’s user and token are the credential. Answers the name the link would confirm. Opening it spends nothing. This is not /portal/verify-email. Rate limited.
The door of the portal’s GET /portal/verify-pseudonym.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
user |
query | The username the link names. | ||
X-Link-Token |
header | string | The single-use secret the link carried in its fragment. | |
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
address |
string | ||
token |
string | ||
username |
string |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.refused |
string |
429: Too many attempts; view.refused says so.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.refused |
string |
503: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.refused |
string |
POST /account-api/verify-pseudonym
verifyPseudonym
Confirms the sign-in name a link names
Spends the link. Answers view.verified, or view.refused. Rate limited. Not the recovery-address link.
The door of the portal’s POST /portal/verify-pseudonym.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
DPoP |
header | string | RFC 9449: the proof of possession for the DPoP-bound access token, which Authorization: DPoP <token> requires. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
token |
``, or string | The link’s single-use secret. | |
user |
``, or string | The username the link names. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
go |
string | ||
message |
string | ||
ok |
boolean | ||
view |
object | ||
view.address |
string | ||
view.username |
string | ||
view.verified |
boolean |
400: The request did not validate, or was refused: { ok: false, errors: [...] }.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.refused |
string |
429: Too many attempts; view.refused says so.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.refused |
string |
503: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
errors |
list | yes | |
errors[] |
string | ||
ok |
boolean | yes | |
view |
object | ||
view.refused |
string |