This is the documentation of iya-sts 1.0.0. The latest is 1.1.0.

Management API

Every answer is checked against the model shown here before it is sent, and no answer carries a member its model does not list. A member shown as any JSON is one whose shape belongs to somebody else, and says whose. .{key} is a key that is data, and [] an element of a list.

A refusal

Unless an operation below says otherwise, any status it does not list answers this:

Member Type Required What it is
error string    
error_description string    
errors list    
errors[] string    
message string    
ok boolean    
status integer    
why string    

GET /admin-api/webauthn

getWebauthnSettings

The security-key ceremony’s settings, and what a key may be here

Every webauthn.* setting, in four kinds. THE CEREMONY: the RP name, the RP ID override, the algorithms offered (with the three flags that widen or narrow them: insecureAlgorithms, pqcOnly and pqcAlongsideClassical), the user verification requirement, the attestation conveyance and the timeout — handed to the browser in the PublicKeyCredential options. CTAP2: the authenticator attachment and whether credProps is asked for; whether the credential is discoverable (a resident key) is the passkey policy’s securityKeyResidentKey since #527, not a setting here. POLICY: whether a key may be a primary credential, whether it may be a second factor, and how many one person may hold — which are not WebAuthn at all but what THIS service does with a key.

NOT ONE OF THESE EXISTED UNTIL 2026-09-10. Every ceremony parameter was a literal in a string in authn/authn.ts, and this service said there was nothing an operator could usefully turn — true of the cryptography and false of the ceremony.

ONE IS ENFORCED AND THE REST ARE REQUESTS. webauthn.userVerification is sent to the browser AND checked against the UV flag when the ceremony returns, because that flag is inside the bytes the authenticator signed. Nothing signed says what the browser was asked about attestation, the resident key or the attachment, so a check on those would compare against a value this service itself supplied — what it does instead is RECORD what came back.

THE ATTESTATION STATEMENT (#105): webauthn.attestationPolicy and the six settings beside it — trust anchors, an AAGUID allow-list, a certification level, FIPS, SafetyNet and Android software keys. status reports the policy in force, the eight formats verified and the FIDO Metadata Service BLOB (status.mds); the BLOB itself is uploaded through POST /risk/import, where #62 put it. What each key’s statement proved is on GET /users, per key.

status carries the COSE algorithm table, read from authn/webauthn.js — the module that checks the signature — with the offered ones marked.

Who holds a key is GET /users, and removing one is POST /users/clear-key.

THERE IS NO POST BESIDE THIS ONE and that is not a gap: every form on the console page this mirrors posts set-many to /admin/config, so POST /admin-api/config/set-many is already the operation for it. One store, one action, two doors.

Mirrors GET /admin/webauthn on the admin console.

The reply also carries protocolEndpoints: every endpoint of this family in the realm the call arrived in, as { name, methods, url } (plus route for an HTTP endpoint, transport for a socket, and registered: false for a route the router no longer has).

Scope: admin:read.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

200: What the page says, and the settings it draws — described rows carrying each value’s source and whether it can be changed while the service runs.

Member Type Required What it is
alsoHtml list    
alsoHtml[] string    
leadHtml string    
links list    
links[].href string    
links[].what string    
notes list    
notes[] string    
page string    
protocolEndpoints list    
protocolEndpoints[].listening boolean    
protocolEndpoints[].methods list, or string    
protocolEndpoints[].methods[] string    
protocolEndpoints[].name string    
protocolEndpoints[].registered boolean    
protocolEndpoints[].route string    
protocolEndpoints[].transport string    
protocolEndpoints[].url string    
settings object    
settings.context object    
settings.context.configFile string, or null    
settings.context.defaultsFile string, or null    
settings.context.inRealm boolean    
settings.context.persistenceMode string    
settings.context.persistsAppconfig boolean    
settings.context.persistsRealms boolean    
settings.context.realmId string    
settings.editableCount integer    
settings.groups list    
settings.groups[].group string    
settings.groups[].settings list    
settings.groups[].settings[].appconfigPath string    
settings.groups[].settings[].csvValueNotes map    
settings.groups[].settings[].csvValueNotes.{key} string    
settings.groups[].settings[].csvValues list    
settings.groups[].settings[].csvValues[] string, or number, or boolean, or null    
settings.groups[].settings[].default list, or string, or number, or boolean, or null    
settings.groups[].settings[].default[] string, or number, or boolean, or null    
settings.groups[].settings[].description string    
settings.groups[].settings[].editRefusal string    
settings.groups[].settings[].editable boolean    
settings.groups[].settings[].enumValues list    
settings.groups[].settings[].enumValues[] string, or number, or boolean, or null    
settings.groups[].settings[].env list, or string    
settings.groups[].settings[].env[] string    
settings.groups[].settings[].group string    
settings.groups[].settings[].key string    
settings.groups[].settings[].label string    
settings.groups[].settings[].legacyEnv list, or string    
settings.groups[].settings[].legacyEnv[] string    
settings.groups[].settings[].masked boolean    
settings.groups[].settings[].max number    
settings.groups[].settings[].min number    
settings.groups[].settings[].ordered boolean    
settings.groups[].settings[].overridden boolean    
settings.groups[].settings[].realmSettable boolean    
settings.groups[].settings[].restartReason string    
settings.groups[].settings[].selectAll object    
settings.groups[].settings[].selectAll.aloneWhileOn list    
settings.groups[].settings[].selectAll.aloneWhileOn[].canBeOn object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.aloneWhileOn[].on object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.aloneWhileOn[].setting object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.aloneWhileOn[].values object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.onlyWhileOn list    
settings.groups[].settings[].selectAll.onlyWhileOn[].canBeOn object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.onlyWhileOn[].on object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.onlyWhileOn[].setting object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.onlyWhileOn[].values object   Nested deeper than this page draws.
settings.groups[].settings[].source string    
settings.groups[].settings[].step number    
settings.groups[].settings[].text string, or null    
settings.groups[].settings[].type string    
settings.groups[].settings[].value list, or string, or number, or boolean, or null    
settings.groups[].settings[].value[] string, or number, or boolean, or null    
settings.overridden list    
settings.overridden[] string    
settings.page string    
settings.setWith string    
settings.settingCount integer    
settings.sharedWith map    
settings.sharedWith.{key} list    
settings.sharedWith.{key}[] object, or string    
settings.sharedWith.{key}[].label string    
settings.sharedWith.{key}[].path string    
status object    
status.algorithms list    
status.algorithms[].coseAlg number    
status.algorithms[].insecure boolean    
status.algorithms[].name string    
status.algorithms[].notOfferedBecause string    
status.algorithms[].offered boolean    
status.algorithms[].postQuantum boolean    
status.algorithms[].rank number    
status.algorithmsSource string    
status.attestation string    
status.attestationAllowSafetynet boolean    
status.attestationAllowedAaguids list    
status.attestationAllowedAaguids[] string    
status.attestationAndroidSoftwareKeys boolean    
status.attestationDemandsTrust boolean    
status.attestationFormats list    
status.attestationFormats[] string    
status.attestationMinCertificationLevel string    
status.attestationPolicy string    
status.attestationPolicyConfigured string    
status.attestationRequireFips boolean    
status.attestationTrustAnchors number    
status.attestationVerified boolean    
status.authenticatorAttachment string    
status.clientDataHash string    
status.credProps boolean    
status.curves list    
status.curves[].coseCurve number    
status.curves[].name string    
status.insecureAlgorithms boolean    
status.lanes list    
status.lanes[].algorithms list    
status.lanes[].algorithms[] string    
status.lanes[].lane string    
status.maxKeysPerPerson number    
status.mds object    
status.mds.active boolean    
status.mds.job string    
status.mds.known boolean    
status.mds.loadedAt number    
status.mds.nextUpdateAt number    
status.mds.rows number    
status.mds.serial number    
status.mds.stale boolean    
status.mds.url string    
status.mds.version string    
status.mfaAllowed boolean    
status.offered boolean    
status.pqcAlongsideClassical boolean    
status.pqcOnly boolean    
status.primaryAllowed boolean    
status.registrationMode string    
status.residentKey string    
status.rpId string    
status.rpIdSource string    
status.rpName string    
status.signatureCounter string    
status.timeoutMs number    
status.upgradeAlgorithms list    
status.upgradeAlgorithms[] string    
status.upgradeMode string    
status.userVerification string    
status.userVerificationEnforced boolean    
status.usernameless boolean    
title string    
what string    

400: The answer.

Member Type Required What it is
error string    
error_description string    
errors list    
errors[] string    
message string    
ok boolean yes