This is the documentation of iya-sts 1.0.0. The latest is 1.1.0.
What the sign-in screens read and send. How it is used.
The sign-in screen’s API: what the screen offers for a pending sign-in, and the acts it sends. Unauthenticated and keyed by the pending sign-in’s id; every act is bound to the browser’s session cookie by a CSRF token. Answers name the next step; refusals are English and carry no error code. And the sign-out page’s (#577): what a sign-out would end for the person the session names, and the act that ends it.
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 | ||
next |
one of refused |
||
ok |
boolean |
GET /authn-api
getIndex
Lists every operation of this API
Each operation, its method and path, and the sign-in page or control it is the door of.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
api |
string | ||
openapi |
string | ||
operations |
list | ||
operations[].access |
string | ||
operations[].action |
string, or null | ||
operations[].method |
one of GET, POST |
||
operations[].mirrors |
string, or null | ||
operations[].operationId |
string | ||
operations[].path |
string | ||
operations[].summary |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean |
GET /authn-api/accounts
getAccounts
The accounts this browser holds
Each signed-in and remembered account of the browser’s account set — key, subject, names, state, times, and whether it is the browser’s default — never a sid or a token; enabled false and no accounts where authn.multipleAccounts is off. With it on, anotherAccount is where Sign in with another account starts: the user portal, asked to sign in again.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
accounts |
list | ||
accounts[].authTime |
number | ||
accounts[].current |
boolean | ||
accounts[].displayName |
string | ||
accounts[].key |
string | ||
accounts[].signedInAt |
number | ||
accounts[].signedOutAt |
number | ||
accounts[].state |
one of signed-in, signed-out |
||
accounts[].sub |
string | ||
accounts[].username |
string | ||
anotherAccount |
string | ||
csrf |
string | ||
enabled |
boolean | ||
max |
number | ||
ok |
boolean |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean |
GET /authn-api/consent/{id}
getConsent
What the OAuth consent screen asks
The consent screen’s view, as facts and no words: who is signed in, the application asking (its name and client_id), each scope outstanding and the permission it resolves to, each RFC 9396 authorization detail member by member, the limits a person may lower, what was already agreed, and the request’s own parameters — and csrf. Refused (400) where nothing is pending under the id, or the browser’s session is not the person it was asked of.
The door of the sign-in surface’s GET /oauth2/consent.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The pending consent’s id: a bearer capability, as the consent the consent screen was opened with, answered only to the browser whose session is the person asked. |
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.already |
list | ||
view.already[].at |
string | ||
view.already[].global |
boolean | ||
view.already[].scope |
string | ||
view.attribute |
string | ||
view.authorizationDetails |
list | ||
view.authorizationDetails[].audience |
string | ||
view.authorizationDetails[].description |
string | ||
view.authorizationDetails[].members |
list | ||
view.authorizationDetails[].members[].name |
string | ||
view.authorizationDetails[].members[].value |
string | ||
view.authorizationDetails[].resource |
string | ||
view.authorizationDetails[].type |
string | ||
view.base |
string | ||
view.client |
object | ||
view.client.id |
string | ||
view.client.name |
string | ||
view.clientDisplay |
object | ||
view.clientDisplay.logo |
string | ||
view.clientDisplay.logoOrigin |
string | ||
view.clientDisplay.name |
string | ||
view.clientDisplay.policy |
string | ||
view.clientDisplay.tos |
string | ||
view.consent |
boolean | ||
view.details |
list | ||
view.details[].label |
string | ||
view.details[].note |
string | ||
view.details[].value |
string | ||
view.lifetimeHours |
number | ||
view.limits |
list | ||
view.limits[].limits |
any JSON | The limits member of an RFC 9396 authorization detail, as the client sent it: beyond the six members common/access_limits.ts names, every member is the API’s own, under a schema an operator declared for its type. The limits member of an RFC 9396 authorization detail, as the client sent it: beyond the six members common/access_limits.ts names, every member is the API’s own, under a schema an operator declared for its type. | |
view.limits[].r |
integer | ||
view.limits[].rows |
list | ||
view.limits[].rows[].label |
string | ||
view.limits[].rows[].member |
string | ||
view.limits[].rows[].value |
string | ||
view.limits[].type |
string | ||
view.protocol |
string | ||
view.resources |
list | ||
view.resources[] |
string | ||
view.scopes |
list | ||
view.scopes[].permission |
object | ||
view.scopes[].permission.baseUri |
string | ||
view.scopes[].permission.description |
string | ||
view.scopes[].permission.identifier |
string | ||
view.scopes[].permission.name |
string | ||
view.scopes[].releasesDid |
boolean | ||
view.scopes[].scope |
string | ||
view.scopes[].signsIn |
boolean | ||
view.username |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean |
POST /authn-api/consent/{id}
answerConsent
Allows or denies what the consent screen asks
action: allow writes one oauthConsent value per scope onto the person’s entry and records an RFC 9396 Allow for this one request, with any limit lowered (lim_t0r<n>_<member>, as the page draws them; a raised one is refused); action: deny records nothing. Either way the pending consent is spent and the answer names the authorization request to go back to.
The door of the sign-in surface’s POST /oauth2/consent.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The pending consent’s id: a bearer capability, as the consent the consent screen was opened with, answered only to the browser whose session is the person asked. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
action |
one of allow, deny |
yes |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
GET /authn-api/logout
getSignOut
Everything a sign-out would end
The sign-out page’s view, as facts and no words: every family of live session or credential this service holds for the person the browser’s session names — or username, where naming somebody is open (a development test control) — each row with whether it can be ended and why not, and csrf. Refused (403) for a name that may not be used, and (401) with nobody to act on.
The door of the sign-in surface’s GET /logout.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
username |
query | Whom the page is about, where naming somebody is open (development mode and logout.anyUser), or the caller’s own name; the browser’s session otherwise. |
||
account |
query | string | With authn.multipleAccounts on (#561): one of this browser’s signed-in accounts, by its key. | |
login_hint |
query | string | With authn.multipleAccounts on (#561): the account the sign-out’s account step preselects. | |
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.account |
string | ||
view.accounts |
list | ||
view.accounts[].current |
boolean | ||
view.accounts[].displayName |
string | ||
view.accounts[].key |
string | ||
view.accounts[].username |
string | ||
view.at |
number | ||
view.families |
list | ||
view.families[].failure |
string | ||
view.families[].held |
number | ||
view.families[].id |
string | ||
view.families[].label |
string | ||
view.families[].notListed |
number | ||
view.families[].protocol |
string | ||
view.families[].rows |
list | ||
view.families[].rows[].detail |
string, or null | ||
view.families[].rows[].expiresAt |
number, or null | ||
view.families[].rows[].family |
string | ||
view.families[].rows[].handle |
string, or number | ||
view.families[].rows[].id |
string | ||
view.families[].rows[].kind |
string | ||
view.families[].rows[].label |
string, or null | ||
view.families[].rows[].sessionId |
string, or null | ||
view.families[].rows[].startedAt |
number, or null | ||
view.families[].rows[].terminable |
boolean | ||
view.families[].rows[].why |
string, or null | ||
view.families[].spec |
string | ||
view.families[].terminable |
boolean | ||
view.families[].what |
string | ||
view.key |
string | ||
view.listed |
number | ||
view.maxRows |
number | ||
view.named |
boolean | ||
view.naming |
one of open, off, product |
||
view.notListed |
number | ||
view.preselected |
string | ||
view.sessions |
number | ||
view.state |
one of inventory, accounts, refused, nobody |
||
view.total |
number | ||
view.username |
string | ||
view.verifiesCredentials |
boolean |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.account |
string | ||
view.accounts |
list | ||
view.accounts[].current |
boolean | ||
view.accounts[].displayName |
string | ||
view.accounts[].key |
string | ||
view.accounts[].username |
string | ||
view.at |
number | ||
view.families |
list | ||
view.families[].failure |
string | ||
view.families[].held |
number | ||
view.families[].id |
string | ||
view.families[].label |
string | ||
view.families[].notListed |
number | ||
view.families[].protocol |
string | ||
view.families[].rows |
list | ||
view.families[].rows[].detail |
string, or null | ||
view.families[].rows[].expiresAt |
number, or null | ||
view.families[].rows[].family |
string | ||
view.families[].rows[].handle |
string, or number | ||
view.families[].rows[].id |
string | ||
view.families[].rows[].kind |
string | ||
view.families[].rows[].label |
string, or null | ||
view.families[].rows[].sessionId |
string, or null | ||
view.families[].rows[].startedAt |
number, or null | ||
view.families[].rows[].terminable |
boolean | ||
view.families[].rows[].why |
string, or null | ||
view.families[].spec |
string | ||
view.families[].terminable |
boolean | ||
view.families[].what |
string | ||
view.key |
string | ||
view.listed |
number | ||
view.maxRows |
number | ||
view.named |
boolean | ||
view.naming |
one of open, off, product |
||
view.notListed |
number | ||
view.preselected |
string | ||
view.sessions |
number | ||
view.state |
one of inventory, accounts, refused, nobody |
||
view.total |
number | ||
view.username |
string | ||
view.verifiesCredentials |
boolean |
401: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.account |
string | ||
view.accounts |
list | ||
view.accounts[].current |
boolean | ||
view.accounts[].displayName |
string | ||
view.accounts[].key |
string | ||
view.accounts[].username |
string | ||
view.at |
number | ||
view.families |
list | ||
view.families[].failure |
string | ||
view.families[].held |
number | ||
view.families[].id |
string | ||
view.families[].label |
string | ||
view.families[].notListed |
number | ||
view.families[].protocol |
string | ||
view.families[].rows |
list | ||
view.families[].rows[].detail |
string, or null | ||
view.families[].rows[].expiresAt |
number, or null | ||
view.families[].rows[].family |
string | ||
view.families[].rows[].handle |
string, or number | ||
view.families[].rows[].id |
string | ||
view.families[].rows[].kind |
string | ||
view.families[].rows[].label |
string, or null | ||
view.families[].rows[].sessionId |
string, or null | ||
view.families[].rows[].startedAt |
number, or null | ||
view.families[].rows[].terminable |
boolean | ||
view.families[].rows[].why |
string, or null | ||
view.families[].spec |
string | ||
view.families[].terminable |
boolean | ||
view.families[].what |
string | ||
view.key |
string | ||
view.listed |
number | ||
view.maxRows |
number | ||
view.named |
boolean | ||
view.naming |
one of open, off, product |
||
view.notListed |
number | ||
view.preselected |
string | ||
view.sessions |
number | ||
view.state |
one of inventory, accounts, refused, nobody |
||
view.total |
number | ||
view.username |
string | ||
view.verifiesCredentials |
boolean |
403: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.account |
string | ||
view.accounts |
list | ||
view.accounts[].current |
boolean | ||
view.accounts[].displayName |
string | ||
view.accounts[].key |
string | ||
view.accounts[].username |
string | ||
view.at |
number | ||
view.families |
list | ||
view.families[].failure |
string | ||
view.families[].held |
number | ||
view.families[].id |
string | ||
view.families[].label |
string | ||
view.families[].notListed |
number | ||
view.families[].protocol |
string | ||
view.families[].rows |
list | ||
view.families[].rows[].detail |
string, or null | ||
view.families[].rows[].expiresAt |
number, or null | ||
view.families[].rows[].family |
string | ||
view.families[].rows[].handle |
string, or number | ||
view.families[].rows[].id |
string | ||
view.families[].rows[].kind |
string | ||
view.families[].rows[].label |
string, or null | ||
view.families[].rows[].sessionId |
string, or null | ||
view.families[].rows[].startedAt |
number, or null | ||
view.families[].rows[].terminable |
boolean | ||
view.families[].rows[].why |
string, or null | ||
view.families[].spec |
string | ||
view.families[].terminable |
boolean | ||
view.families[].what |
string | ||
view.key |
string | ||
view.listed |
number | ||
view.maxRows |
number | ||
view.named |
boolean | ||
view.naming |
one of open, off, product |
||
view.notListed |
number | ||
view.preselected |
string | ||
view.sessions |
number | ||
view.state |
one of inventory, accounts, refused, nobody |
||
view.total |
number | ||
view.username |
string | ||
view.verifiesCredentials |
boolean |
POST /authn-api/logout
signOut
Signs out: everything, or what was ticked
A scope of global, or no selection, ends everything the person holds; select ends those rows only, each looked up again now. The answer is the result, or the signed-out document that carries what the browser must still do.
The door of the sign-in surface’s POST /logout.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
account |
string | ||
scope |
``, or one of global, selected |
||
select |
list | ||
select[] |
string | ||
username |
``, or string |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
object | ||
form.fields.result |
string | ||
form.method |
one of POST |
||
location |
string | ||
next |
one of signed-out, inventory, refused |
||
ok |
boolean | ||
ownSessionEnded |
boolean | ||
scope |
one of global, selected |
||
username |
string | ||
view |
object | ||
view.accounts |
list | ||
view.accounts[].current |
boolean | ||
view.accounts[].displayName |
string | ||
view.accounts[].key |
string | ||
view.accounts[].username |
string | ||
view.key |
string | ||
view.message |
string | ||
view.naming |
one of open, off, product |
||
view.preselected |
string | ||
view.remaining |
number | ||
view.scope |
one of global, selected |
||
view.signIn |
string | With state reauthenticate: where to sign in again before ending another session, a path on this service that comes back to the sign-out page. |
|
view.skipped |
list | ||
view.skipped[].id |
string | ||
view.skipped[].label |
string | ||
view.skipped[].message |
string | ||
view.state |
one of result, refused, nobody, accounts, reauthenticate |
||
view.terminated |
list | ||
view.terminated[].id |
string | ||
view.terminated[].label |
string | ||
view.terminated[].message |
string | ||
view.verifiesCredentials |
boolean |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
object | ||
form.fields.result |
string | ||
form.method |
one of POST |
||
location |
string | ||
next |
one of signed-out, inventory, refused |
||
ok |
boolean | ||
ownSessionEnded |
boolean | ||
scope |
one of global, selected |
||
username |
string | ||
view |
object | ||
view.accounts |
list | ||
view.accounts[].current |
boolean | ||
view.accounts[].displayName |
string | ||
view.accounts[].key |
string | ||
view.accounts[].username |
string | ||
view.key |
string | ||
view.message |
string | ||
view.naming |
one of open, off, product |
||
view.preselected |
string | ||
view.remaining |
number | ||
view.scope |
one of global, selected |
||
view.signIn |
string | With state reauthenticate: where to sign in again before ending another session, a path on this service that comes back to the sign-out page. |
|
view.skipped |
list | ||
view.skipped[].id |
string | ||
view.skipped[].label |
string | ||
view.skipped[].message |
string | ||
view.state |
one of result, refused, nobody, accounts, reauthenticate |
||
view.terminated |
list | ||
view.terminated[].id |
string | ||
view.terminated[].label |
string | ||
view.terminated[].message |
string | ||
view.verifiesCredentials |
boolean |
401: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
object | ||
form.fields.result |
string | ||
form.method |
one of POST |
||
location |
string | ||
next |
one of signed-out, inventory, refused |
||
ok |
boolean | ||
ownSessionEnded |
boolean | ||
scope |
one of global, selected |
||
username |
string | ||
view |
object | ||
view.accounts |
list | ||
view.accounts[].current |
boolean | ||
view.accounts[].displayName |
string | ||
view.accounts[].key |
string | ||
view.accounts[].username |
string | ||
view.key |
string | ||
view.message |
string | ||
view.naming |
one of open, off, product |
||
view.preselected |
string | ||
view.remaining |
number | ||
view.scope |
one of global, selected |
||
view.signIn |
string | With state reauthenticate: where to sign in again before ending another session, a path on this service that comes back to the sign-out page. |
|
view.skipped |
list | ||
view.skipped[].id |
string | ||
view.skipped[].label |
string | ||
view.skipped[].message |
string | ||
view.state |
one of result, refused, nobody, accounts, reauthenticate |
||
view.terminated |
list | ||
view.terminated[].id |
string | ||
view.terminated[].label |
string | ||
view.terminated[].message |
string | ||
view.verifiesCredentials |
boolean |
403: No Origin of this service, or no CSRF token bound to this browser’s session; or ending another session needs a recent sign-in (account.recentAuthMinutes), when the answer’s view is reauthenticate and names where to sign in again.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
object | ||
form.fields.result |
string | ||
form.method |
one of POST |
||
location |
string | ||
next |
one of signed-out, inventory, refused |
||
ok |
boolean | ||
ownSessionEnded |
boolean | ||
scope |
one of global, selected |
||
username |
string | ||
view |
object | ||
view.accounts |
list | ||
view.accounts[].current |
boolean | ||
view.accounts[].displayName |
string | ||
view.accounts[].key |
string | ||
view.accounts[].username |
string | ||
view.key |
string | ||
view.message |
string | ||
view.naming |
one of open, off, product |
||
view.preselected |
string | ||
view.remaining |
number | ||
view.scope |
one of global, selected |
||
view.signIn |
string | With state reauthenticate: where to sign in again before ending another session, a path on this service that comes back to the sign-out page. |
|
view.skipped |
list | ||
view.skipped[].id |
string | ||
view.skipped[].label |
string | ||
view.skipped[].message |
string | ||
view.state |
one of result, refused, nobody, accounts, reauthenticate |
||
view.terminated |
list | ||
view.terminated[].id |
string | ||
view.terminated[].label |
string | ||
view.terminated[].message |
string | ||
view.verifiesCredentials |
boolean |
409: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
object | ||
form.fields.result |
string | ||
form.method |
one of POST |
||
location |
string | ||
next |
one of signed-out, inventory, refused |
||
ok |
boolean | ||
ownSessionEnded |
boolean | ||
scope |
one of global, selected |
||
username |
string | ||
view |
object | ||
view.accounts |
list | ||
view.accounts[].current |
boolean | ||
view.accounts[].displayName |
string | ||
view.accounts[].key |
string | ||
view.accounts[].username |
string | ||
view.key |
string | ||
view.message |
string | ||
view.naming |
one of open, off, product |
||
view.preselected |
string | ||
view.remaining |
number | ||
view.scope |
one of global, selected |
||
view.signIn |
string | With state reauthenticate: where to sign in again before ending another session, a path on this service that comes back to the sign-out page. |
|
view.skipped |
list | ||
view.skipped[].id |
string | ||
view.skipped[].label |
string | ||
view.skipped[].message |
string | ||
view.state |
one of result, refused, nobody, accounts, reauthenticate |
||
view.terminated |
list | ||
view.terminated[].id |
string | ||
view.terminated[].label |
string | ||
view.terminated[].message |
string | ||
view.verifiesCredentials |
boolean |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
object | ||
form.fields.result |
string | ||
form.method |
one of POST |
||
location |
string | ||
next |
one of signed-out, inventory, refused |
||
ok |
boolean | ||
ownSessionEnded |
boolean | ||
scope |
one of global, selected |
||
username |
string | ||
view |
object | ||
view.accounts |
list | ||
view.accounts[].current |
boolean | ||
view.accounts[].displayName |
string | ||
view.accounts[].key |
string | ||
view.accounts[].username |
string | ||
view.key |
string | ||
view.message |
string | ||
view.naming |
one of open, off, product |
||
view.preselected |
string | ||
view.remaining |
number | ||
view.scope |
one of global, selected |
||
view.signIn |
string | With state reauthenticate: where to sign in again before ending another session, a path on this service that comes back to the sign-out page. |
|
view.skipped |
list | ||
view.skipped[].id |
string | ||
view.skipped[].label |
string | ||
view.skipped[].message |
string | ||
view.state |
one of result, refused, nobody, accounts, reauthenticate |
||
view.terminated |
list | ||
view.terminated[].id |
string | ||
view.terminated[].label |
string | ||
view.terminated[].message |
string | ||
view.verifiesCredentials |
boolean |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
object | ||
form.fields.result |
string | ||
form.method |
one of POST |
||
location |
string | ||
next |
one of signed-out, inventory, refused |
||
ok |
boolean | ||
ownSessionEnded |
boolean | ||
scope |
one of global, selected |
||
username |
string | ||
view |
object | ||
view.accounts |
list | ||
view.accounts[].current |
boolean | ||
view.accounts[].displayName |
string | ||
view.accounts[].key |
string | ||
view.accounts[].username |
string | ||
view.key |
string | ||
view.message |
string | ||
view.naming |
one of open, off, product |
||
view.preselected |
string | ||
view.remaining |
number | ||
view.scope |
one of global, selected |
||
view.signIn |
string | With state reauthenticate: where to sign in again before ending another session, a path on this service that comes back to the sign-out page. |
|
view.skipped |
list | ||
view.skipped[].id |
string | ||
view.skipped[].label |
string | ||
view.skipped[].message |
string | ||
view.state |
one of result, refused, nobody, accounts, reauthenticate |
||
view.terminated |
list | ||
view.terminated[].id |
string | ||
view.terminated[].label |
string | ||
view.terminated[].message |
string | ||
view.verifiesCredentials |
boolean |
GET /authn-api/logout/accounts
getSignOutAccounts
Which account a sign-out is for
The sign-out’s account step: this browser’s signed-in accounts, each by its key, names and whether it is the browser’s default — never a sid — the one login_hint names, preselected, and csrf. 400 where authn.multipleAccounts is off.
The door of the sign-in surface’s GET /logout/accounts.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
username |
query | Whom the page is about, where naming somebody is open (development mode and logout.anyUser), or the caller’s own name; the browser’s session otherwise. |
||
account |
query | string | With authn.multipleAccounts on (#561): one of this browser’s signed-in accounts, by its key. | |
login_hint |
query | string | With authn.multipleAccounts on (#561): the account the sign-out’s account step preselects. | |
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.accounts |
list | ||
view.accounts[].current |
boolean | ||
view.accounts[].displayName |
string | ||
view.accounts[].key |
string | ||
view.accounts[].username |
string | ||
view.naming |
one of open, off, product |
||
view.preselected |
string | ||
view.state |
one of accounts |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.accounts |
list | ||
view.accounts[].current |
boolean | ||
view.accounts[].displayName |
string | ||
view.accounts[].key |
string | ||
view.accounts[].username |
string | ||
view.naming |
one of open, off, product |
||
view.preselected |
string | ||
view.state |
one of accounts |
POST /authn-api/logout/accounts
chooseSignOutAccount
Chooses the account to sign out, or every account
An account’s key answers next: inventory and the address of that person’s sign-out page; all signs every account in this browser out — each person’s own global sign-out — and answers as POST /authn-api/logout does. 409 for an account no longer signed in here.
The door of the sign-in surface’s POST /logout/accounts.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
account |
string | yes |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
object | ||
form.fields.result |
string | ||
form.method |
one of POST |
||
location |
string | ||
next |
one of signed-out, inventory, refused |
||
ok |
boolean | ||
ownSessionEnded |
boolean | ||
scope |
one of global, selected |
||
username |
string | ||
view |
object | ||
view.accounts |
list | ||
view.accounts[].current |
boolean | ||
view.accounts[].displayName |
string | ||
view.accounts[].key |
string | ||
view.accounts[].username |
string | ||
view.key |
string | ||
view.message |
string | ||
view.naming |
one of open, off, product |
||
view.preselected |
string | ||
view.remaining |
number | ||
view.scope |
one of global, selected |
||
view.signIn |
string | With state reauthenticate: where to sign in again before ending another session, a path on this service that comes back to the sign-out page. |
|
view.skipped |
list | ||
view.skipped[].id |
string | ||
view.skipped[].label |
string | ||
view.skipped[].message |
string | ||
view.state |
one of result, refused, nobody, accounts, reauthenticate |
||
view.terminated |
list | ||
view.terminated[].id |
string | ||
view.terminated[].label |
string | ||
view.terminated[].message |
string | ||
view.verifiesCredentials |
boolean |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
object | ||
form.fields.result |
string | ||
form.method |
one of POST |
||
location |
string | ||
next |
one of signed-out, inventory, refused |
||
ok |
boolean | ||
ownSessionEnded |
boolean | ||
scope |
one of global, selected |
||
username |
string | ||
view |
object | ||
view.accounts |
list | ||
view.accounts[].current |
boolean | ||
view.accounts[].displayName |
string | ||
view.accounts[].key |
string | ||
view.accounts[].username |
string | ||
view.key |
string | ||
view.message |
string | ||
view.naming |
one of open, off, product |
||
view.preselected |
string | ||
view.remaining |
number | ||
view.scope |
one of global, selected |
||
view.signIn |
string | With state reauthenticate: where to sign in again before ending another session, a path on this service that comes back to the sign-out page. |
|
view.skipped |
list | ||
view.skipped[].id |
string | ||
view.skipped[].label |
string | ||
view.skipped[].message |
string | ||
view.state |
one of result, refused, nobody, accounts, reauthenticate |
||
view.terminated |
list | ||
view.terminated[].id |
string | ||
view.terminated[].label |
string | ||
view.terminated[].message |
string | ||
view.verifiesCredentials |
boolean |
401: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
object | ||
form.fields.result |
string | ||
form.method |
one of POST |
||
location |
string | ||
next |
one of signed-out, inventory, refused |
||
ok |
boolean | ||
ownSessionEnded |
boolean | ||
scope |
one of global, selected |
||
username |
string | ||
view |
object | ||
view.accounts |
list | ||
view.accounts[].current |
boolean | ||
view.accounts[].displayName |
string | ||
view.accounts[].key |
string | ||
view.accounts[].username |
string | ||
view.key |
string | ||
view.message |
string | ||
view.naming |
one of open, off, product |
||
view.preselected |
string | ||
view.remaining |
number | ||
view.scope |
one of global, selected |
||
view.signIn |
string | With state reauthenticate: where to sign in again before ending another session, a path on this service that comes back to the sign-out page. |
|
view.skipped |
list | ||
view.skipped[].id |
string | ||
view.skipped[].label |
string | ||
view.skipped[].message |
string | ||
view.state |
one of result, refused, nobody, accounts, reauthenticate |
||
view.terminated |
list | ||
view.terminated[].id |
string | ||
view.terminated[].label |
string | ||
view.terminated[].message |
string | ||
view.verifiesCredentials |
boolean |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
object | ||
form.fields.result |
string | ||
form.method |
one of POST |
||
location |
string | ||
next |
one of signed-out, inventory, refused |
||
ok |
boolean | ||
ownSessionEnded |
boolean | ||
scope |
one of global, selected |
||
username |
string | ||
view |
object | ||
view.accounts |
list | ||
view.accounts[].current |
boolean | ||
view.accounts[].displayName |
string | ||
view.accounts[].key |
string | ||
view.accounts[].username |
string | ||
view.key |
string | ||
view.message |
string | ||
view.naming |
one of open, off, product |
||
view.preselected |
string | ||
view.remaining |
number | ||
view.scope |
one of global, selected |
||
view.signIn |
string | With state reauthenticate: where to sign in again before ending another session, a path on this service that comes back to the sign-out page. |
|
view.skipped |
list | ||
view.skipped[].id |
string | ||
view.skipped[].label |
string | ||
view.skipped[].message |
string | ||
view.state |
one of result, refused, nobody, accounts, reauthenticate |
||
view.terminated |
list | ||
view.terminated[].id |
string | ||
view.terminated[].label |
string | ||
view.terminated[].message |
string | ||
view.verifiesCredentials |
boolean |
409: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
object | ||
form.fields.result |
string | ||
form.method |
one of POST |
||
location |
string | ||
next |
one of signed-out, inventory, refused |
||
ok |
boolean | ||
ownSessionEnded |
boolean | ||
scope |
one of global, selected |
||
username |
string | ||
view |
object | ||
view.accounts |
list | ||
view.accounts[].current |
boolean | ||
view.accounts[].displayName |
string | ||
view.accounts[].key |
string | ||
view.accounts[].username |
string | ||
view.key |
string | ||
view.message |
string | ||
view.naming |
one of open, off, product |
||
view.preselected |
string | ||
view.remaining |
number | ||
view.scope |
one of global, selected |
||
view.signIn |
string | With state reauthenticate: where to sign in again before ending another session, a path on this service that comes back to the sign-out page. |
|
view.skipped |
list | ||
view.skipped[].id |
string | ||
view.skipped[].label |
string | ||
view.skipped[].message |
string | ||
view.state |
one of result, refused, nobody, accounts, reauthenticate |
||
view.terminated |
list | ||
view.terminated[].id |
string | ||
view.terminated[].label |
string | ||
view.terminated[].message |
string | ||
view.verifiesCredentials |
boolean |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
object | ||
form.fields.result |
string | ||
form.method |
one of POST |
||
location |
string | ||
next |
one of signed-out, inventory, refused |
||
ok |
boolean | ||
ownSessionEnded |
boolean | ||
scope |
one of global, selected |
||
username |
string | ||
view |
object | ||
view.accounts |
list | ||
view.accounts[].current |
boolean | ||
view.accounts[].displayName |
string | ||
view.accounts[].key |
string | ||
view.accounts[].username |
string | ||
view.key |
string | ||
view.message |
string | ||
view.naming |
one of open, off, product |
||
view.preselected |
string | ||
view.remaining |
number | ||
view.scope |
one of global, selected |
||
view.signIn |
string | With state reauthenticate: where to sign in again before ending another session, a path on this service that comes back to the sign-out page. |
|
view.skipped |
list | ||
view.skipped[].id |
string | ||
view.skipped[].label |
string | ||
view.skipped[].message |
string | ||
view.state |
one of result, refused, nobody, accounts, reauthenticate |
||
view.terminated |
list | ||
view.terminated[].id |
string | ||
view.terminated[].label |
string | ||
view.terminated[].message |
string | ||
view.verifiesCredentials |
boolean |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
account |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
object | ||
form.fields.result |
string | ||
form.method |
one of POST |
||
location |
string | ||
next |
one of signed-out, inventory, refused |
||
ok |
boolean | ||
ownSessionEnded |
boolean | ||
scope |
one of global, selected |
||
username |
string | ||
view |
object | ||
view.accounts |
list | ||
view.accounts[].current |
boolean | ||
view.accounts[].displayName |
string | ||
view.accounts[].key |
string | ||
view.accounts[].username |
string | ||
view.key |
string | ||
view.message |
string | ||
view.naming |
one of open, off, product |
||
view.preselected |
string | ||
view.remaining |
number | ||
view.scope |
one of global, selected |
||
view.signIn |
string | With state reauthenticate: where to sign in again before ending another session, a path on this service that comes back to the sign-out page. |
|
view.skipped |
list | ||
view.skipped[].id |
string | ||
view.skipped[].label |
string | ||
view.skipped[].message |
string | ||
view.state |
one of result, refused, nobody, accounts, reauthenticate |
||
view.terminated |
list | ||
view.terminated[].id |
string | ||
view.terminated[].label |
string | ||
view.terminated[].message |
string | ||
view.verifiesCredentials |
boolean |
GET /authn-api/mfa/{id}
getStep
What a second-factor or emailed-factor step’s page shows
The step’s view for the page page names (totp, webauthn, backup-code, password, setup, email-code, email-link, email-link-open, post-login; the step’s own where left out), as facts and no words: the person, the ways round the factor asked for, the set-up step’s choice and its authenticator app’s otpauth: URI, the passkey ceremony’s description, an emailed factor’s state — and csrf. Refused (400) where the page could never be drawn for the step: an expired step, a code page for somebody with no authenticator app, a passkey page for somebody holding no passkey (any key may answer the step since #1135; the authentication policy decides whether this use is open). key names the passkey a person chose where the passkey policy offers them one by one.
The door of the sign-in surface’s GET /authn/totp, /authn/webauthn, /authn/backup-code, /authn/password-factor, /authn/mfa-setup, /authn/email-code, /authn/email-link, /authn/email-link/open, /authn/post-login.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The second-factor or emailed-factor step’s id: a bearer capability, as the mfa its page was opened with. |
page |
query | Which of the step’s pages; the step’s own where left out. | ||
key |
query | The passkey a person chose, where the passkey policy offers them one by one (#534). | ||
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.address |
string | ||
view.amr |
list | ||
view.amr[] |
string | ||
view.backup |
object | ||
view.backup.back |
string | ||
view.backup.factor |
one of passkey, code, link, app |
||
view.backup.low |
boolean | ||
view.backup.remaining |
number | ||
view.backup.total |
number | ||
view.clientDisplay |
object | ||
view.clientDisplay.logo |
string | ||
view.clientDisplay.logoOrigin |
string | ||
view.clientDisplay.name |
string | ||
view.clientDisplay.policy |
string | ||
view.clientDisplay.tos |
string | ||
view.id |
string | ||
view.kind |
one of code, link |
||
view.links |
object | ||
view.links.backup |
boolean | ||
view.links.email |
string | ||
view.links.password |
boolean | ||
view.links.totp |
boolean | ||
view.links.wallet |
boolean | ||
view.links.webauthn |
boolean | ||
view.minutes |
number | ||
view.notice |
string | ||
view.others |
object | ||
view.others.backup |
boolean | ||
view.others.password |
boolean | ||
view.others.totp |
boolean | ||
view.others.webauthn |
boolean | ||
view.page |
string | ||
view.passwordless |
boolean | ||
view.postLogin |
object | ||
view.postLogin.activity |
string | ||
view.postLogin.canSkip |
boolean | ||
view.postLogin.deadline |
string | ||
view.postLogin.failed |
string | ||
view.postLogin.method |
string | ||
view.postLogin.reason |
string | ||
view.postLogin.required |
boolean | ||
view.postLogin.separate |
boolean | ||
view.postLogin.snoozeDays |
number | ||
view.primary |
boolean | ||
view.seconds |
number | ||
view.sentence |
string | ||
view.setup |
object | ||
view.setup.offered |
object | ||
view.setup.offered.totp |
boolean | ||
view.setup.offered.webauthn |
boolean | ||
view.setup.optional |
boolean | ||
view.setup.proved |
boolean | ||
view.setup.recovery |
boolean | ||
view.setup.state |
one of choose, totp |
||
view.setup.totp |
object | ||
view.setup.totp.algorithm |
string | ||
view.setup.totp.digits |
number | ||
view.setup.totp.period |
number | ||
view.setup.totp.secret |
string | ||
view.setup.totp.uri |
string | ||
view.state |
one of ask, code, wait, open, elsewhere, end |
||
view.title |
string | ||
view.totp |
object | ||
view.totp.digits |
number | ||
view.totp.period |
number | ||
view.username |
string | ||
view.webauthn |
object | ||
view.webauthn.algorithms |
list | ||
view.webauthn.algorithms[] |
string | ||
view.webauthn.attachment |
string | ||
view.webauthn.attestation |
string | ||
view.webauthn.challenge |
string | ||
view.webauthn.choices |
list | ||
view.webauthn.choices[].id |
string | ||
view.webauthn.choices[].name |
string | ||
view.webauthn.chosen |
object | ||
view.webauthn.chosen.id |
string | ||
view.webauthn.chosen.name |
string | ||
view.webauthn.fallback |
object | ||
view.webauthn.fallback.asksPostQuantum |
boolean | ||
view.webauthn.fallback.classical |
boolean | ||
view.webauthn.fallback.retrying |
boolean | ||
view.webauthn.fallback.upgrade |
boolean | ||
view.webauthn.hardwareRefused |
object | ||
view.webauthn.hardwareRefused.why |
string | ||
view.webauthn.lane |
string | ||
view.webauthn.lanes |
list | ||
view.webauthn.lanes[] |
string | ||
view.webauthn.mode |
one of create, get |
||
view.webauthn.passwordless |
boolean | ||
view.webauthn.postLogin |
object | ||
view.webauthn.postLogin.required |
boolean | ||
view.webauthn.postLogin.upgrade |
object | ||
view.webauthn.postLogin.upgrade.name |
string | ||
view.webauthn.postLogin.upgrade.phase |
one of proof, registration |
||
view.webauthn.postLogin.upgrade.previousAlgorithm |
string | ||
view.webauthn.postQuantumAllowCredentials |
string | ||
view.webauthn.postQuantumHelp |
object | ||
view.webauthn.postQuantumHelp.register |
string | ||
view.webauthn.postQuantumRefused |
object | ||
view.webauthn.postQuantumRefused.why |
string | ||
view.webauthn.problem |
string | ||
view.webauthn.residentKey |
string | ||
view.webauthn.rpId |
string | ||
view.webauthn.userVerification |
string | ||
view.webauthn.widened |
boolean |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.address |
string | ||
view.amr |
list | ||
view.amr[] |
string | ||
view.backup |
object | ||
view.backup.back |
string | ||
view.backup.factor |
one of passkey, code, link, app |
||
view.backup.low |
boolean | ||
view.backup.remaining |
number | ||
view.backup.total |
number | ||
view.clientDisplay |
object | ||
view.clientDisplay.logo |
string | ||
view.clientDisplay.logoOrigin |
string | ||
view.clientDisplay.name |
string | ||
view.clientDisplay.policy |
string | ||
view.clientDisplay.tos |
string | ||
view.id |
string | ||
view.kind |
one of code, link |
||
view.links |
object | ||
view.links.backup |
boolean | ||
view.links.email |
string | ||
view.links.password |
boolean | ||
view.links.totp |
boolean | ||
view.links.wallet |
boolean | ||
view.links.webauthn |
boolean | ||
view.minutes |
number | ||
view.notice |
string | ||
view.others |
object | ||
view.others.backup |
boolean | ||
view.others.password |
boolean | ||
view.others.totp |
boolean | ||
view.others.webauthn |
boolean | ||
view.page |
string | ||
view.passwordless |
boolean | ||
view.postLogin |
object | ||
view.postLogin.activity |
string | ||
view.postLogin.canSkip |
boolean | ||
view.postLogin.deadline |
string | ||
view.postLogin.failed |
string | ||
view.postLogin.method |
string | ||
view.postLogin.reason |
string | ||
view.postLogin.required |
boolean | ||
view.postLogin.separate |
boolean | ||
view.postLogin.snoozeDays |
number | ||
view.primary |
boolean | ||
view.seconds |
number | ||
view.sentence |
string | ||
view.setup |
object | ||
view.setup.offered |
object | ||
view.setup.offered.totp |
boolean | ||
view.setup.offered.webauthn |
boolean | ||
view.setup.optional |
boolean | ||
view.setup.proved |
boolean | ||
view.setup.recovery |
boolean | ||
view.setup.state |
one of choose, totp |
||
view.setup.totp |
object | ||
view.setup.totp.algorithm |
string | ||
view.setup.totp.digits |
number | ||
view.setup.totp.period |
number | ||
view.setup.totp.secret |
string | ||
view.setup.totp.uri |
string | ||
view.state |
one of ask, code, wait, open, elsewhere, end |
||
view.title |
string | ||
view.totp |
object | ||
view.totp.digits |
number | ||
view.totp.period |
number | ||
view.username |
string | ||
view.webauthn |
object | ||
view.webauthn.algorithms |
list | ||
view.webauthn.algorithms[] |
string | ||
view.webauthn.attachment |
string | ||
view.webauthn.attestation |
string | ||
view.webauthn.challenge |
string | ||
view.webauthn.choices |
list | ||
view.webauthn.choices[].id |
string | ||
view.webauthn.choices[].name |
string | ||
view.webauthn.chosen |
object | ||
view.webauthn.chosen.id |
string | ||
view.webauthn.chosen.name |
string | ||
view.webauthn.fallback |
object | ||
view.webauthn.fallback.asksPostQuantum |
boolean | ||
view.webauthn.fallback.classical |
boolean | ||
view.webauthn.fallback.retrying |
boolean | ||
view.webauthn.fallback.upgrade |
boolean | ||
view.webauthn.hardwareRefused |
object | ||
view.webauthn.hardwareRefused.why |
string | ||
view.webauthn.lane |
string | ||
view.webauthn.lanes |
list | ||
view.webauthn.lanes[] |
string | ||
view.webauthn.mode |
one of create, get |
||
view.webauthn.passwordless |
boolean | ||
view.webauthn.postLogin |
object | ||
view.webauthn.postLogin.required |
boolean | ||
view.webauthn.postLogin.upgrade |
object | ||
view.webauthn.postLogin.upgrade.name |
string | ||
view.webauthn.postLogin.upgrade.phase |
one of proof, registration |
||
view.webauthn.postLogin.upgrade.previousAlgorithm |
string | ||
view.webauthn.postQuantumAllowCredentials |
string | ||
view.webauthn.postQuantumHelp |
object | ||
view.webauthn.postQuantumHelp.register |
string | ||
view.webauthn.postQuantumRefused |
object | ||
view.webauthn.postQuantumRefused.why |
string | ||
view.webauthn.problem |
string | ||
view.webauthn.residentKey |
string | ||
view.webauthn.rpId |
string | ||
view.webauthn.userVerification |
string | ||
view.webauthn.widened |
boolean |
POST /authn-api/mfa/{id}/backup-code
spendRecoveryCode
Checks and spends a recovery code
In place of the second factor; a code that cannot be marked spent is refused.
The door of the sign-in surface’s POST /authn/backup-code.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The second-factor or emailed-factor step’s id: a bearer capability, as the mfa its page was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
code |
string |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/mfa/{id}/email-link/open
spendEmailedLink
Spends a mailed sign-in link: its Continue button
Only in the browser that asked for the link (the sts_email_binding cookie). Opening the link spends nothing.
The door of the sign-in surface’s POST /authn/email-link/open.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The second-factor or emailed-factor step’s id: a bearer capability, as the mfa its page was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
t |
``, or string |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/mfa/{id}/email/code
checkEmailedCode
Checks an emailed code
Once for the cluster, a bounded number of wrong codes per step, rate limited as the one-time code is.
The door of the sign-in surface’s POST /authn/email-code.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The second-factor or emailed-factor step’s id: a bearer capability, as the mfa its page was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
code |
string |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/mfa/{id}/email/send
sendEmailedFactor
Mails a code or a sign-in link for the step (#64)
To the person’s verified address only; a resend replaces the last. next: stay with notice: resent where it went. A link’s binding cookie is set on this answer.
The door of the sign-in surface’s POST /authn/email-code, /authn/email-link.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The second-factor or emailed-factor step’s id: a bearer capability, as the mfa its page was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
kind |
one of code, link |
yes |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/mfa/{id}/password
checkFactorPassword
Checks a password as the second factor after a wallet
Rate limited on the sign-in bucket.
The door of the sign-in surface’s POST /authn/password-factor.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The second-factor or emailed-factor step’s id: a bearer capability, as the mfa its page was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
password |
string |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/mfa/{id}/post-login/register
registerPostLoginPasskey
Chooses to register the passkey a post-login activity asks for
The next step is the passkey page’s registration, offering ML-DSA only; the key has no role (#1135). Its finish starts the session the sign-in was held for. Where the realm can no longer enrol an ML-DSA passkey the session starts without it (STS-AUTHN-0475).
The door of the sign-in surface’s POST /authn/post-login.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The second-factor or emailed-factor step’s id: a bearer capability, as the mfa its page was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
An empty object.
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/mfa/{id}/post-login/skip
skipPostLoginActivity
Puts a post-login activity off
For the profile’s snoozeDays; the held session starts. Refused (400) once the allotted time since the first invitation has passed (STS-AUTHN-0474).
The door of the sign-in surface’s POST /authn/post-login.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The second-factor or emailed-factor step’s id: a bearer capability, as the mfa its page was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
An empty object.
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/mfa/{id}/setup/confirm
confirmAppEnrolment
Confirms an authenticator app with its first code
Rate limited; on success a session of two factors.
The door of the sign-in surface’s POST /authn/mfa-setup.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The second-factor or emailed-factor step’s id: a bearer capability, as the mfa its page was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
code |
string |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/mfa/{id}/setup/totp
beginAppEnrolment
Begins enrolling an authenticator app at the set-up step
The next step is the set-up page again, drawing the secret.
The door of the sign-in surface’s POST /authn/mfa-setup.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The second-factor or emailed-factor step’s id: a bearer capability, as the mfa its page was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
An empty object.
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/mfa/{id}/setup/webauthn
beginKeyEnrolment
Chooses a passkey at the set-up step
The next step is the passkey page’s registration.
The door of the sign-in surface’s POST /authn/mfa-setup.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The second-factor or emailed-factor step’s id: a bearer capability, as the mfa its page was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
An empty object.
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/mfa/{id}/skip
ignoreOffer
Ignores an offered second factor (#246)
Only where the step was offered rather than required: the sign-in finishes on the password.
The door of the sign-in surface’s POST /authn/mfa-setup.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The second-factor or emailed-factor step’s id: a bearer capability, as the mfa its page was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
An empty object.
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/mfa/{id}/start-over
startOver
Leaves a sign-in step and starts the sign-in over
Every second-factor, set-up and emailed-factor page’s Start over button. The step is ended with whatever it held (an emailed code, a link, an enrolment in progress), no session is started and no factor is counted, and the pending sign-in the step was minted from is put back under its id, so the request it carries completes after the person signs in again. next: redirect to the sign-in screen; a step that has already ended is refused (400).
The door of the sign-in surface’s POST /authn/totp, /authn/webauthn, /authn/backup-code, /authn/password-factor, /authn/mfa-setup, /authn/email-code, /authn/email-link, /authn/email-link/open.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The second-factor or emailed-factor step’s id: a bearer capability, as the mfa its page was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
An empty object.
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/mfa/{id}/totp
checkCode
Checks a one-time code from an authenticator app
RFC 6238, checked in every mode and rate limited by identity and address; a refused code keeps the step.
The door of the sign-in surface’s POST /authn/totp.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The second-factor or emailed-factor step’s id: a bearer capability, as the mfa its page was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
code |
string |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/mfa/{id}/webauthn
finishPasskeyStep
Verifies the passkey step’s ceremony and finishes the step
A registration where the step enrols a key, an assertion otherwise — decided by the step, not the body.
The door of the sign-in surface’s POST /authn/webauthn.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The second-factor or emailed-factor step’s id: a bearer capability, as the mfa its page was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
credential |
string |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/mfa/{id}/webauthn/options
passkeyStepOptions
Arms the passkey step’s ceremony
The step’s challenge, the RP ID, the user (its handle and display name), the keys allowed and excluded and the passkey policy’s options, for navigator.credentials.create() or .get() as mode says. lane (classical or pqc) chooses the lane a registration is made in where the realm offers both (#643): its handle, its algorithms and its exclude list. algorithms: classical (#944) arms a registration with the classical algorithms only, the retry fallback.classical says may be offered after an ML-DSA-first registration failed on the device; refused (400) where the realm forbids a classical passkey.
The door of the sign-in surface’s POST /authn/webauthn.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The second-factor or emailed-factor step’s id: a bearer capability, as the mfa its page was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
algorithms |
``, or one of classical |
||
key |
``, or string | ||
lane |
``, or one of classical, pqc |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
allow |
list | ||
allow[] |
string | ||
challenge |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
exclude |
list | ||
exclude[] |
string | ||
fallback |
object | ||
fallback.asksPostQuantum |
boolean | ||
fallback.classical |
boolean | ||
fallback.retrying |
boolean | ||
fallback.upgrade |
boolean | ||
mode |
one of create, get |
||
next |
one of refused |
||
ok |
boolean | ||
options |
object | ||
options.algorithms |
list | ||
options.algorithms[] |
number, or null | ||
options.attestation |
string | ||
options.authenticatorSelection |
object | ||
options.authenticatorSelection.authenticatorAttachment |
string | ||
options.authenticatorSelection.requireResidentKey |
boolean | ||
options.authenticatorSelection.residentKey |
string | ||
options.authenticatorSelection.userVerification |
string | ||
options.credProps |
boolean | ||
options.hints |
list | ||
options.hints[] |
string | ||
options.minPinLength |
boolean | ||
options.rp |
object | ||
options.rp.id |
string | ||
options.rp.name |
string | ||
options.rpId |
string | ||
options.timeout |
number | ||
options.userVerification |
string | ||
rpId |
string | ||
user |
object | ||
user.displayName |
string | ||
user.id |
string | ||
user.name |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
allow |
list | ||
allow[] |
string | ||
challenge |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
exclude |
list | ||
exclude[] |
string | ||
fallback |
object | ||
fallback.asksPostQuantum |
boolean | ||
fallback.classical |
boolean | ||
fallback.retrying |
boolean | ||
fallback.upgrade |
boolean | ||
mode |
one of create, get |
||
next |
one of refused |
||
ok |
boolean | ||
options |
object | ||
options.algorithms |
list | ||
options.algorithms[] |
number, or null | ||
options.attestation |
string | ||
options.authenticatorSelection |
object | ||
options.authenticatorSelection.authenticatorAttachment |
string | ||
options.authenticatorSelection.requireResidentKey |
boolean | ||
options.authenticatorSelection.residentKey |
string | ||
options.authenticatorSelection.userVerification |
string | ||
options.credProps |
boolean | ||
options.hints |
list | ||
options.hints[] |
string | ||
options.minPinLength |
boolean | ||
options.rp |
object | ||
options.rp.id |
string | ||
options.rp.name |
string | ||
options.rpId |
string | ||
options.timeout |
number | ||
options.userVerification |
string | ||
rpId |
string | ||
user |
object | ||
user.displayName |
string | ||
user.id |
string | ||
user.name |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
allow |
list | ||
allow[] |
string | ||
challenge |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
exclude |
list | ||
exclude[] |
string | ||
fallback |
object | ||
fallback.asksPostQuantum |
boolean | ||
fallback.classical |
boolean | ||
fallback.retrying |
boolean | ||
fallback.upgrade |
boolean | ||
mode |
one of create, get |
||
next |
one of refused |
||
ok |
boolean | ||
options |
object | ||
options.algorithms |
list | ||
options.algorithms[] |
number, or null | ||
options.attestation |
string | ||
options.authenticatorSelection |
object | ||
options.authenticatorSelection.authenticatorAttachment |
string | ||
options.authenticatorSelection.requireResidentKey |
boolean | ||
options.authenticatorSelection.residentKey |
string | ||
options.authenticatorSelection.userVerification |
string | ||
options.credProps |
boolean | ||
options.hints |
list | ||
options.hints[] |
string | ||
options.minPinLength |
boolean | ||
options.rp |
object | ||
options.rp.id |
string | ||
options.rp.name |
string | ||
options.rpId |
string | ||
options.timeout |
number | ||
options.userVerification |
string | ||
rpId |
string | ||
user |
object | ||
user.displayName |
string | ||
user.id |
string | ||
user.name |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
allow |
list | ||
allow[] |
string | ||
challenge |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
exclude |
list | ||
exclude[] |
string | ||
fallback |
object | ||
fallback.asksPostQuantum |
boolean | ||
fallback.classical |
boolean | ||
fallback.retrying |
boolean | ||
fallback.upgrade |
boolean | ||
mode |
one of create, get |
||
next |
one of refused |
||
ok |
boolean | ||
options |
object | ||
options.algorithms |
list | ||
options.algorithms[] |
number, or null | ||
options.attestation |
string | ||
options.authenticatorSelection |
object | ||
options.authenticatorSelection.authenticatorAttachment |
string | ||
options.authenticatorSelection.requireResidentKey |
boolean | ||
options.authenticatorSelection.residentKey |
string | ||
options.authenticatorSelection.userVerification |
string | ||
options.credProps |
boolean | ||
options.hints |
list | ||
options.hints[] |
string | ||
options.minPinLength |
boolean | ||
options.rp |
object | ||
options.rp.id |
string | ||
options.rp.name |
string | ||
options.rpId |
string | ||
options.timeout |
number | ||
options.userVerification |
string | ||
rpId |
string | ||
user |
object | ||
user.displayName |
string | ||
user.id |
string | ||
user.name |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
allow |
list | ||
allow[] |
string | ||
challenge |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
exclude |
list | ||
exclude[] |
string | ||
fallback |
object | ||
fallback.asksPostQuantum |
boolean | ||
fallback.classical |
boolean | ||
fallback.retrying |
boolean | ||
fallback.upgrade |
boolean | ||
mode |
one of create, get |
||
next |
one of refused |
||
ok |
boolean | ||
options |
object | ||
options.algorithms |
list | ||
options.algorithms[] |
number, or null | ||
options.attestation |
string | ||
options.authenticatorSelection |
object | ||
options.authenticatorSelection.authenticatorAttachment |
string | ||
options.authenticatorSelection.requireResidentKey |
boolean | ||
options.authenticatorSelection.residentKey |
string | ||
options.authenticatorSelection.userVerification |
string | ||
options.credProps |
boolean | ||
options.hints |
list | ||
options.hints[] |
string | ||
options.minPinLength |
boolean | ||
options.rp |
object | ||
options.rp.id |
string | ||
options.rp.name |
string | ||
options.rpId |
string | ||
options.timeout |
number | ||
options.userVerification |
string | ||
rpId |
string | ||
user |
object | ||
user.displayName |
string | ||
user.id |
string | ||
user.name |
string |
GET /authn-api/openapi.json
getOpenApi
This API’s OpenAPI document
Generated from the operation table and its body schemas.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
components |
any JSON | The operations and components of an OpenAPI document are that specification’s vocabulary, not this API’s, and this document describes itself with them. The operations and components of an OpenAPI document are that specification’s vocabulary, not this API’s, and this document describes itself with them. | |
info |
object | ||
info.description |
string | ||
info.title |
string | ||
info.version |
string | ||
openapi |
string | ||
paths |
any JSON | The operations and components of an OpenAPI document are that specification’s vocabulary, not this API’s, and this document describes itself with them. The operations and components of an OpenAPI document are that specification’s vocabulary, not this API’s, and this document describes itself with them. | |
servers |
list | ||
servers[].url |
string | ||
tags |
list | ||
tags[].name |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean |
GET /authn-api/password-change/{id}
getPasswordChange
The forced password change a sign-in is waiting on
Whose password, and why it must be changed now where there is a reason to give; csrf as for the screen.
The door of the sign-in surface’s GET /authn/password-change.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The password change step’s id. |
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.id |
string | ||
view.notice |
string | ||
view.username |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean |
POST /authn-api/password-change/{id}
changePassword
Stores the new password and continues the sign-in
Held to the password policy; the sign-in then continues exactly as after the password step — second factor included.
The door of the sign-in surface’s POST /authn/password-change.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The password change step’s id. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
confirm_password |
string | ||
new_password |
string |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/password-change/{id}/start-over
startOverFromPasswordChange
Leaves the forced password change and starts the sign-in over
Changes nothing: the step is ended and the pending sign-in it was minted from is put back under its id, so the request it carries completes after the person signs in again. next: redirect to the sign-in screen.
The door of the sign-in surface’s POST /authn/password-change.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The password change step’s id. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
An empty object.
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
GET /authn-api/pending/{id}
getScreen
What the sign-in screen offers for a pending sign-in
The screen’s view, as facts and no words: the authentication policy’s mechanisms, the passkey policy’s boxes, the demands the calling protocol made, the partners, the Kerberos and wallet doors, what this mode checks, and the protocol’s own rows — and csrf, the token every act on this sign-in carries.
The door of the sign-in surface’s GET /authn/login.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The pending sign-in’s id: a bearer capability, as the authn the screen was opened with. |
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.anonymous |
boolean | ||
view.application |
string | ||
view.base |
string | ||
view.certificate |
object | ||
view.certificate.mfaNote |
boolean | ||
view.certificate.name |
string | ||
view.clientDisplay |
object | ||
view.clientDisplay.logo |
string | ||
view.clientDisplay.logoOrigin |
string | ||
view.clientDisplay.name |
string | ||
view.clientDisplay.policy |
string | ||
view.clientDisplay.tos |
string | ||
view.demands |
object | ||
view.demands.key |
boolean | ||
view.demands.mfa |
boolean | ||
view.demands.passwordless |
boolean | ||
view.demands.via |
string | ||
view.details |
list | ||
view.details[].label |
string | ||
view.details[].note |
string | ||
view.details[].value |
string | ||
view.email |
object | ||
view.email.code |
boolean | ||
view.email.link |
boolean | ||
view.error |
string | ||
view.fingerprint |
boolean | ||
view.forgot |
string | ||
view.hint |
string | ||
view.id |
string | ||
view.kerberos |
object | ||
view.kerberos.href |
string | ||
view.kerberos.state |
one of offered, withheld-key, withheld-mfa |
||
view.keys |
object | ||
view.keys.enabled |
boolean | ||
view.keys.mfaAllowed |
boolean | ||
view.keys.primaryAllowed |
boolean | ||
view.locked |
string | ||
view.partners |
object | ||
view.partners.kind |
one of own-one, own-many, any |
||
view.partners.options |
list | ||
view.partners.options[].category |
string | ||
view.partners.options[].href |
string | ||
view.partners.options[].id |
string | ||
view.partners.options[].label |
string | ||
view.partners.options[].peer |
string | ||
view.partners.options[].protocolLabel |
string | ||
view.partners.options[].provider |
string | ||
view.passkey |
boolean | ||
view.password |
boolean | ||
view.postQuantumRequired |
object | ||
view.postQuantumRequired.register |
string | ||
view.protocol |
string | ||
view.reauthentication |
string | ||
view.remember |
boolean | ||
view.screen |
boolean | ||
view.usernameless |
boolean | ||
view.verifiesCredentials |
boolean | ||
view.wallet |
object | ||
view.wallet.href |
string | ||
view.wallet.mfaNote |
boolean | ||
view.wallet.siop |
string | ||
view.wallet.state |
one of offered, withheld |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean |
GET /authn-api/pending/{id}/accounts
getAccountChoice
The accounts a sign-in may continue as
The account picker’s view: this browser’s signed-in accounts and the signed-out ones it remembers — each by its key, names, state and times, never a sid — whether Use another account is open, and the protocol’s own rows; and csrf. 503 with Retry-After where the browser’s account set, or a session it lists, could not be read.
The door of the sign-in surface’s GET /authn/accounts.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The pending sign-in’s id: a bearer capability, as the authn the screen was opened with. |
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.accounts |
list | ||
view.accounts[].authTime |
number | ||
view.accounts[].current |
boolean | ||
view.accounts[].displayName |
string | ||
view.accounts[].key |
string | ||
view.accounts[].signedInAt |
number | ||
view.accounts[].signedOutAt |
number | ||
view.accounts[].state |
one of signed-in, signed-out |
||
view.accounts[].sub |
string | ||
view.accounts[].username |
string | ||
view.another |
object | ||
view.another.open |
boolean | ||
view.application |
string | ||
view.base |
string | ||
view.details |
list | ||
view.details[].label |
string | ||
view.details[].note |
string | ||
view.details[].value |
string | ||
view.id |
string | ||
view.max |
number | ||
view.protocol |
string | ||
view.reason |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean |
503: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean |
POST /authn-api/pending/{id}/accounts/another
useAnotherAccount
Signs in as another account
The sign-in the picker stood in front of, with nothing filled in; refused while every place the browser has is a signed-in account.
The door of the sign-in surface’s POST /authn/accounts.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The pending sign-in’s id: a bearer capability, as the authn the screen was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
An empty object.
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
409: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
503: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/pending/{id}/accounts/forget
forgetAccount
Forgets a signed-out account
Only an account that signed out in this browser; a signed-in one is signed out at /logout. No session is touched.
The door of the sign-in surface’s POST /authn/accounts.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The pending sign-in’s id: a bearer capability, as the authn the screen was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
account |
string | yes |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
409: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
503: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/pending/{id}/accounts/select
selectAccount
Continues as one of this browser’s accounts
The account is checked again: its session must still be live in this browser, and a demand for two factors it does not meet sends the person to sign in again as that account. A signed-out account goes to the sign-in with its name filled in. Every selection rotates the sts_accounts handle. 503 with Retry-After where the browser’s accounts could not be read.
The door of the sign-in surface’s POST /authn/accounts.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The pending sign-in’s id: a bearer capability, as the authn the screen was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
account |
string | yes |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
409: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
503: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/pending/{id}/anonymous
continueAnonymously
Continues without signing in
Where authn.unauthenticatedSessions is on: a session that records that nobody authenticated.
The door of the sign-in surface’s POST /authn/login.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The pending sign-in’s id: a bearer capability, as the authn the screen was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
device_fp |
string | ||
remember_browser |
``, or one of 0, 1, true, false, on, off, yes, no |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
As application/json:
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
As text/plain.
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/pending/{id}/cancel
cancelSignIn
Declines the sign-in
Cancel: the calling protocol is told the person declined (authn_error=access_denied) at location.
The door of the sign-in surface’s POST /authn/login.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The pending sign-in’s id: a bearer capability, as the authn the screen was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
An empty object.
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
As application/json:
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
As text/plain.
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/pending/{id}/certificate
continueWithCertificate
Continues as the holder of the connection’s TLS client certificate
Where the view offers certificate (#1051): the TLS client certificate this connection presented, its revocation consulted, the identity gate asked for this sign-in’s realm, and an application’s certificate refused — the checks GET /tls/sign-in makes — as a first factor, amr ["swk"]. The authentication policy, the risk and the issuance policy decide as for any first factor, and a second factor is the next step where one is needed.
The door of the sign-in surface’s POST /authn/login.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The pending sign-in’s id: a bearer capability, as the authn the screen was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
device_fp |
string | ||
remember_browser |
``, or one of 0, 1, true, false, on, off, yes, no |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
As application/json:
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
As text/plain.
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/pending/{id}/email
signInByEmail
Mails a sign-in code or link as a first factor
Where the authentication policy accepts one (#64): the next step is the page that waits for it, the same whether or not the account exists.
The door of the sign-in surface’s POST /authn/login.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The pending sign-in’s id: a bearer capability, as the authn the screen was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
device_fp |
string | ||
kind |
one of code, link |
yes | |
remember_browser |
``, or one of 0, 1, true, false, on, off, yes, no |
||
username |
``, or string |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
As application/json:
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
As text/plain.
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
GET /authn-api/pending/{id}/partners
getPartners
The federation partners a sign-in may choose between
Resolved again from the application’s entry; with fewer than two left, go names the sign-in screen instead.
The door of the sign-in surface’s GET /authn/select-idp.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The pending sign-in’s id: a bearer capability, as the authn the screen was opened with. |
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
go |
string | ||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.application |
string | ||
view.base |
string | ||
view.details |
list | ||
view.details[].label |
string | ||
view.details[].note |
string | ||
view.details[].value |
string | ||
view.id |
string | ||
view.partners |
list | ||
view.partners[].category |
string | ||
view.partners[].href |
string | ||
view.partners[].id |
string | ||
view.partners[].label |
string | ||
view.partners[].peer |
string | ||
view.partners[].protocolLabel |
string | ||
view.partners[].provider |
string | ||
view.problems |
list | ||
view.problems[] |
string | ||
view.protocol |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean |
POST /authn-api/pending/{id}/passkey
signInWithPasskey
Signs in with a passkey and no username
The ceremony’s result, verified with user verification required against the challenge passkey/options armed.
The door of the sign-in surface’s POST /authn/login.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The pending sign-in’s id: a bearer capability, as the authn the screen was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
credential |
string | ||
device_fp |
string | ||
remember_browser |
``, or one of 0, 1, true, false, on, off, yes, no |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
As application/json:
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
As text/plain.
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
POST /authn-api/pending/{id}/passkey/options
passkeyOptions
Arms a passkey ceremony with no username
A single-use challenge on the pending sign-in, the RP ID and the request options, for the button and the username field’s autofill (conditional mediation).
The door of the sign-in surface’s POST /authn/login.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The pending sign-in’s id: a bearer capability, as the authn the screen was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
An empty object.
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
challenge |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
options |
object | ||
options.hints |
list | ||
options.hints[] |
string | ||
options.rpId |
string | ||
options.timeout |
number | ||
options.userVerification |
string | ||
rpId |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
challenge |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
options |
object | ||
options.hints |
list | ||
options.hints[] |
string | ||
options.rpId |
string | ||
options.timeout |
number | ||
options.userVerification |
string | ||
rpId |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
challenge |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
options |
object | ||
options.hints |
list | ||
options.hints[] |
string | ||
options.rpId |
string | ||
options.timeout |
number | ||
options.userVerification |
string | ||
rpId |
string |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
challenge |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
options |
object | ||
options.hints |
list | ||
options.hints[] |
string | ||
options.rpId |
string | ||
options.timeout |
number | ||
options.userVerification |
string | ||
rpId |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
challenge |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
options |
object | ||
options.hints |
list | ||
options.hints[] |
string | ||
options.rpId |
string | ||
options.timeout |
number | ||
options.userVerification |
string | ||
rpId |
string |
POST /authn-api/pending/{id}/password
signInWithPassword
Signs in with a username and password, or a passkey for the named account
The Sign In button: the password checked (in product mode), rate limited by identity and address, the risk assessed, the issuance policy asked, and the second factor, the set-up step or the forced password change answered as the next step. webauthn_only asks for a passkey instead of the password.
The door of the sign-in surface’s POST /authn/login.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id |
path | string | yes | The pending sign-in’s id: a bearer capability, as the authn the screen was opened with. |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
device_fp |
string | ||
password |
string | ||
remember_browser |
``, or one of 0, 1, true, false, on, off, yes, no |
||
use_webauthn |
``, or one of 0, 1, true, false, on, off, yes, no |
||
username |
``, or string | ||
webauthn_only |
``, or one of 0, 1, true, false, on, off, yes, no |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
As application/json:
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
As text/plain.
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
id |
string | ||
location |
string | ||
next |
one of redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
step |
string |
GET /authn-api/wallet
getWalletStart
What a wallet sign-in’s start page needs
Takes the start page’s query — authn (a pending sign-in) or mfa (a second-factor step), siop=1 for a self-issued ID Token, enrol=1 to enrol one from a session (with login_hint naming which of the browser’s accounts, and did_act one of a published DID’s wallet acts, #1291) — and answers what is being started and csrf, after the refusals a start would meet. It creates nothing.
The door of the sign-in surface’s GET /authn/wallet.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
authn |
query | A pending sign-in. | ||
mfa |
query | A second-factor step. | ||
siop |
query | 1 for a self-issued ID Token rather than a presentation. |
||
enrol |
query | 1 to enrol a key from a session rather than to sign in. |
||
login_hint |
query | Which of this browser’s accounts an enrolment is for. | ||
did_act |
query | A published DID’s wallet act, on an enrolment (#1291). | ||
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.kind |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.secondFactor |
boolean | ||
view.verdict |
string | ||
view.wallet |
one of start, refused |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.kind |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.secondFactor |
boolean | ||
view.verdict |
string | ||
view.wallet |
one of start, refused |
401: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.kind |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.secondFactor |
boolean | ||
view.verdict |
string | ||
view.wallet |
one of start, refused |
403: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.kind |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.secondFactor |
boolean | ||
view.verdict |
string | ||
view.wallet |
one of start, refused |
404: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.kind |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.secondFactor |
boolean | ||
view.verdict |
string | ||
view.wallet |
one of start, refused |
409: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.kind |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.secondFactor |
boolean | ||
view.verdict |
string | ||
view.wallet |
one of start, refused |
410: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.kind |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.secondFactor |
boolean | ||
view.verdict |
string | ||
view.wallet |
one of start, refused |
500: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.kind |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.secondFactor |
boolean | ||
view.verdict |
string | ||
view.wallet |
one of start, refused |
503: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.kind |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.secondFactor |
boolean | ||
view.verdict |
string | ||
view.wallet |
one of start, refused |
POST /authn-api/wallet
startWalletSignIn
Starts a wallet sign-in
An OpenID4VP request bound to the pending sign-in (or the step, or the enrolment) and to this browser by the sts_wallet_binding cookie this answer sets; go names the wait page.
The door of the sign-in surface’s GET /authn/wallet.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
authn |
``, or string | ||
did_act |
``, or string | ||
enrol |
``, or one of 1 |
||
login_hint |
``, or string | ||
mfa |
``, or string | ||
siop |
``, or one of 1 |
||
wallet |
``, or string, uri |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
401: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
404: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
409: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
410: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
500: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
503: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
GET /authn-api/wallet/{state}
getWalletWait
What the wallet sign-in’s wait page draws
For the browser that started the transaction only: the Digital Credentials API request, the same-device link (sameDevice: the request under the scheme a wallet app registers for, oid4vp.walletInvocation), a configured web wallet’s link (webWallet, or empty), the QR code’s text where oid4vp.signInCrossDevice offers it, the seconds left and the poll’s interval, and csrf.
The door of the sign-in surface’s GET /authn/wallet/wait.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
state |
path | string | yes | The wallet sign-in’s transaction: a bearer capability, answered to this browser only (its sts_wallet_binding cookie). |
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.authn |
string | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.dcRequest |
object | ||
view.dcRequest.data |
object | ||
view.dcRequest.data.request |
string | ||
view.dcRequest.protocol |
string | ||
view.enrol |
boolean | ||
view.expiresIn |
number | ||
view.heading |
string | ||
view.kind |
string | ||
view.mfa |
string | ||
view.pollSeconds |
number | ||
view.protocol |
string | ||
view.qr |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.sameDevice |
string | ||
view.secondFactor |
boolean | ||
view.state |
string | ||
view.verdict |
string | ||
view.verifier |
string | ||
view.wallet |
one of wait, refused |
||
view.webWallet |
string |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.authn |
string | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.dcRequest |
object | ||
view.dcRequest.data |
object | ||
view.dcRequest.data.request |
string | ||
view.dcRequest.protocol |
string | ||
view.enrol |
boolean | ||
view.expiresIn |
number | ||
view.heading |
string | ||
view.kind |
string | ||
view.mfa |
string | ||
view.pollSeconds |
number | ||
view.protocol |
string | ||
view.qr |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.sameDevice |
string | ||
view.secondFactor |
boolean | ||
view.state |
string | ||
view.verdict |
string | ||
view.verifier |
string | ||
view.wallet |
one of wait, refused |
||
view.webWallet |
string |
401: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.authn |
string | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.dcRequest |
object | ||
view.dcRequest.data |
object | ||
view.dcRequest.data.request |
string | ||
view.dcRequest.protocol |
string | ||
view.enrol |
boolean | ||
view.expiresIn |
number | ||
view.heading |
string | ||
view.kind |
string | ||
view.mfa |
string | ||
view.pollSeconds |
number | ||
view.protocol |
string | ||
view.qr |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.sameDevice |
string | ||
view.secondFactor |
boolean | ||
view.state |
string | ||
view.verdict |
string | ||
view.verifier |
string | ||
view.wallet |
one of wait, refused |
||
view.webWallet |
string |
403: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.authn |
string | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.dcRequest |
object | ||
view.dcRequest.data |
object | ||
view.dcRequest.data.request |
string | ||
view.dcRequest.protocol |
string | ||
view.enrol |
boolean | ||
view.expiresIn |
number | ||
view.heading |
string | ||
view.kind |
string | ||
view.mfa |
string | ||
view.pollSeconds |
number | ||
view.protocol |
string | ||
view.qr |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.sameDevice |
string | ||
view.secondFactor |
boolean | ||
view.state |
string | ||
view.verdict |
string | ||
view.verifier |
string | ||
view.wallet |
one of wait, refused |
||
view.webWallet |
string |
404: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.authn |
string | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.dcRequest |
object | ||
view.dcRequest.data |
object | ||
view.dcRequest.data.request |
string | ||
view.dcRequest.protocol |
string | ||
view.enrol |
boolean | ||
view.expiresIn |
number | ||
view.heading |
string | ||
view.kind |
string | ||
view.mfa |
string | ||
view.pollSeconds |
number | ||
view.protocol |
string | ||
view.qr |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.sameDevice |
string | ||
view.secondFactor |
boolean | ||
view.state |
string | ||
view.verdict |
string | ||
view.verifier |
string | ||
view.wallet |
one of wait, refused |
||
view.webWallet |
string |
409: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.authn |
string | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.dcRequest |
object | ||
view.dcRequest.data |
object | ||
view.dcRequest.data.request |
string | ||
view.dcRequest.protocol |
string | ||
view.enrol |
boolean | ||
view.expiresIn |
number | ||
view.heading |
string | ||
view.kind |
string | ||
view.mfa |
string | ||
view.pollSeconds |
number | ||
view.protocol |
string | ||
view.qr |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.sameDevice |
string | ||
view.secondFactor |
boolean | ||
view.state |
string | ||
view.verdict |
string | ||
view.verifier |
string | ||
view.wallet |
one of wait, refused |
||
view.webWallet |
string |
410: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.authn |
string | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.dcRequest |
object | ||
view.dcRequest.data |
object | ||
view.dcRequest.data.request |
string | ||
view.dcRequest.protocol |
string | ||
view.enrol |
boolean | ||
view.expiresIn |
number | ||
view.heading |
string | ||
view.kind |
string | ||
view.mfa |
string | ||
view.pollSeconds |
number | ||
view.protocol |
string | ||
view.qr |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.sameDevice |
string | ||
view.secondFactor |
boolean | ||
view.state |
string | ||
view.verdict |
string | ||
view.verifier |
string | ||
view.wallet |
one of wait, refused |
||
view.webWallet |
string |
500: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.authn |
string | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.dcRequest |
object | ||
view.dcRequest.data |
object | ||
view.dcRequest.data.request |
string | ||
view.dcRequest.protocol |
string | ||
view.enrol |
boolean | ||
view.expiresIn |
number | ||
view.heading |
string | ||
view.kind |
string | ||
view.mfa |
string | ||
view.pollSeconds |
number | ||
view.protocol |
string | ||
view.qr |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.sameDevice |
string | ||
view.secondFactor |
boolean | ||
view.state |
string | ||
view.verdict |
string | ||
view.verifier |
string | ||
view.wallet |
one of wait, refused |
||
view.webWallet |
string |
503: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
csrf |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
next |
one of refused |
||
ok |
boolean | ||
preferredLanguage |
object | ||
preferredLanguage.populated |
boolean | ||
preferredLanguage.value |
string | ||
uiLocales |
string | ||
view |
object | ||
view.authn |
string | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.dcRequest |
object | ||
view.dcRequest.data |
object | ||
view.dcRequest.data.request |
string | ||
view.dcRequest.protocol |
string | ||
view.enrol |
boolean | ||
view.expiresIn |
number | ||
view.heading |
string | ||
view.kind |
string | ||
view.mfa |
string | ||
view.pollSeconds |
number | ||
view.protocol |
string | ||
view.qr |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.sameDevice |
string | ||
view.secondFactor |
boolean | ||
view.state |
string | ||
view.verdict |
string | ||
view.verifier |
string | ||
view.wallet |
one of wait, refused |
||
view.webWallet |
string |
POST /authn-api/wallet/{state}/dc-api
answerWalletDcApi
The Digital Credentials API’s answer
The DigitalCredential navigator.credentials.get() answered, from a page on this service’s own origin: decrypted where the request asked for dc_api.jwt, verified with origin:<origin> as the audience, answered once, and the sign-in finished in this request.
The door of the sign-in surface’s GET /authn/wallet/wait.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
state |
path | string | yes | The wallet sign-in’s transaction: a bearer capability, answered to this browser only (its sts_wallet_binding cookie). |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
authn |
``, or string | ||
enrol |
``, or one of 1 |
||
mfa |
``, or string | ||
response |
object, or string | ||
response.data |
any JSON | yes | |
response.protocol |
string | yes |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
401: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
404: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
409: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
410: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
500: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
503: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
POST /authn-api/wallet/{state}/status
walletStatus
Whether the wallet has answered, and the sign-in once it has
The poll: wait until the wallet has answered, then the sign-in finished in this request — once, in the browser that started it, with the right response_code where one is carried.
The door of the sign-in surface’s GET /authn/wallet/wait.
Sent with Content-Type: application/json, an Origin of this service and X-CSRF-Token — the csrf the page’s view answered, bound to the browser’s sts_session cookie.
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
state |
path | string | yes | The wallet sign-in’s transaction: a bearer capability, answered to this browser only (its sts_wallet_binding cookie). |
X-CSRF-Token |
header | string | The csrf the page’s view answered, bound to the browser’s sts_session cookie. |
|
X-Requested-With |
header | string | Added by an Android WebView, naming the application that hosts the page. This API reads nothing in it. | |
X-Step-Id |
header | string | A sign-in step’s id (#1454), kept out of every address: a page sends - in place of the id in a /mfa/, /pending/, /password-change/ or /consent/ path and the id here. Read only on those paths. |
|
X-Step-Query |
header | string | The authn, mfa and enrol query values a page took off the address (#1454), as a query string. Read as if they were in the query. |
Request body
| Member | Type | Required | What it is |
|---|---|---|---|
authn |
``, or string | ||
enrol |
``, or one of 1 |
||
mfa |
``, or string | ||
response_code |
``, or string |
200: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
400: Refused: { ok: false, errors } — the body, the id, or the act itself.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
401: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
403: No Origin of this service, or no CSRF token bound to this browser’s session.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
404: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
409: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
410: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
415: Not a JSON body.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
429: Too many attempts.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
500: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |
503: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
end |
object | ||
end.title |
string | ||
error |
string | ||
error_description |
string | ||
errors |
list | ||
errors[] |
string | ||
expiresIn |
number | ||
form |
object | ||
form.action |
string | ||
form.fields |
map | A request’s own parameters, by name. | |
form.fields.{key} |
string | ||
form.method |
one of GET, POST |
||
go |
string | ||
id |
string | ||
location |
string | ||
next |
one of wait, redirect, mfa, password-change, home-cell, stay, refused |
||
notice |
string | ||
ok |
boolean | ||
passkey |
object | ||
passkey.autofill |
boolean | ||
passkey.unknownCredential |
string | ||
state |
string | ||
step |
string | ||
view |
object | ||
view.back |
string | ||
view.backKind |
one of portal, screen, none |
||
view.checks |
list | ||
view.checks[].detail |
string | ||
view.checks[].name |
string | ||
view.checks[].ok |
boolean | ||
view.heading |
string | ||
view.reissue |
string | ||
view.retry |
string | ||
view.verdict |
string | ||
view.wallet |
one of refused |