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

Management API

The rules this realm holds a credential to — the password policy first: its minimum length, how many previous passwords may not be reused, and the symbol, uppercase and digit rules, stored as cn=default,ou=passwordPolicies in the directory and ENFORCED IN PRODUCT MODE at every door that sets a password. Not the XACML policy repository, which is under XACML.

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/policies

getPolicies

The policies this realm holds a credential to

Every kind of policy and its profiles — the PASSWORD POLICY and the AUTHENTICATION POLICY (#64), one profile each, default. Each kind is a member named by its id (password, authn) and a row of kinds.

<kind>.profile is the profile IN FORCE: the stored entry where there is one (stored: true) and the built-in defaults where there is not — and, for the authentication policy only, the DEFAULT REALM’s entry in a realm with none of its own (from: "default-realm"). sources says where each value came from, and problems names any stored value that could not be read.

enforced is whether this realm checks the password policy, which is product mode. The authentication policy decides what the sign-in screen offers in both modes; authn.mail.usable says whether its two email mechanisms can be on here, and a field with disabled: true cannot be turned on until it can.

attributes is the attribute policy (#396): required the attributes every person here must hold, catalogue every attribute a person may be given (each locked, required, custom), custom the realm’s own attributes, enforced whether it is enforced (product mode), and missingFilter the LDAP filter finding a person who lacks one.

passkey.clients is the realm’s learned passkey clients (#1112): the browsers, systems and major versions a registration stopped offering ML-DSA to under webauthn.clientLearning (learning says whether it is on, threshold and windowHours its two settings), and those still being counted, each client, learned, learnedAt, learnedFailures, failures (in the window), firstAt and lastAt; learned first. Paged by clientsPage and clientsPer (paging), apart from the profiles. clear-passkey-client and clear-passkey-clients clear them.

A kind with NAMED profiles (#535, #1235) carries selectors (the selector fields its save takes), references (the attribute by which an application, a group and/or a person names one of its profiles: appPasskeyPolicy and stsPasskeyPolicy for the passkey policy; stsServiceAccountPolicy, on a service account and nobody else, for the service-account policy (#1240)) and named, each profile with its precedence and namedBy — the applications, groups and people whose reference names it. Of the profile an application names, the profile a person names and the profiles the person’s groups name, the lowest precedence applies (ties by name), else default; a profile something still names cannot be deleted.

It is NOT the XACML policy repository, which is GET /admin-api/xacml/policies.

Mirrors GET /admin/policies on the admin console.

Scope: admin:read.

Parameters

Name In Type Required What it is
page query integer   Which page of the match to return. CLAMPED rather than refused: a page past the end returns the last one, and the reply says which page it actually is.
per query integer   Rows per page. Defaults to 50 and is capped at 300. On a drill-down it is SHARED by every list in the reply, which each carry a page number of their own.
missing query one of count   count answers attributes.missing: how many people in this realm lack a value of an attribute the attribute policy requires. A walk of the realm’s people, so asked only on request, and null where the directory is held in the store (attributes.missingFilter is the LDAP filter that finds them there).
clientsPage query integer   Which page of passkey.clients.rows, the learned passkey clients. Defaults to 1.
clientsPer query integer   Rows per page of passkey.clients.rows. Defaults to 25.
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

200: The kinds of policy, each kind’s profile in force with its field table and schema, and the paged profiles.

Member Type Required What it is
actions list    
actions[] string    
attributes object    
attributes.actions object    
attributes.actions.define string    
attributes.actions.remove string    
attributes.actions.update string    
attributes.alwaysRequired list    
attributes.alwaysRequired[] string    
attributes.catalogue list    
attributes.catalogue[].custom boolean    
attributes.catalogue[].label string    
attributes.catalogue[].locked boolean    
attributes.catalogue[].name string    
attributes.catalogue[].required boolean    
attributes.catalogue[].schema string    
attributes.custom list    
attributes.custom[].description string    
attributes.custom[].dn string    
attributes.custom[].label string    
attributes.custom[].multi boolean    
attributes.custom[].name string    
attributes.custom[].portalEditable boolean    
attributes.custom[].portalVisible boolean    
attributes.custom[].syntax string    
attributes.defaults map    
attributes.defaults.{key} list, or string, or number, or boolean, or null    
attributes.defaults.{key}[] string, or number, or boolean, or null    
attributes.enforced boolean    
attributes.fields list    
attributes.fields[].attribute string    
attributes.fields[].default list, or string, or number, or boolean, or null    
attributes.fields[].default[] string, or number, or boolean, or null    
attributes.fields[].disabled boolean    
attributes.fields[].disabledWhy string    
attributes.fields[].email boolean    
attributes.fields[].empty string    
attributes.fields[].key string    
attributes.fields[].label string    
attributes.fields[].max number    
attributes.fields[].mechanism string    
attributes.fields[].min number    
attributes.fields[].role string    
attributes.fields[].source string, or null    
attributes.fields[].type string    
attributes.fields[].unit string    
attributes.fields[].value list, or string, or number, or boolean, or null    
attributes.fields[].value[] string, or number, or boolean, or null    
attributes.fields[].values list    
attributes.fields[].values[] string, or number, or boolean, or null    
attributes.fields[].what string    
attributes.maxCustom integer    
attributes.missing integer, or null    
attributes.missingAsked boolean    
attributes.missingFilter string    
attributes.named list    
attributes.named[].description string    
attributes.named[].dn string    
attributes.named[].fields list    
attributes.named[].fields[].attribute string    
attributes.named[].fields[].default list, or string, or number, or boolean, or null    
attributes.named[].fields[].default[] string, or number, or boolean, or null    
attributes.named[].fields[].disabled boolean    
attributes.named[].fields[].disabledWhy string    
attributes.named[].fields[].email boolean    
attributes.named[].fields[].empty string    
attributes.named[].fields[].key string    
attributes.named[].fields[].label string    
attributes.named[].fields[].max number    
attributes.named[].fields[].mechanism string    
attributes.named[].fields[].min number    
attributes.named[].fields[].role string    
attributes.named[].fields[].source string, or null    
attributes.named[].fields[].type string    
attributes.named[].fields[].unit string    
attributes.named[].fields[].value list, or string, or number, or boolean, or null    
attributes.named[].fields[].value[] string, or number, or boolean, or null    
attributes.named[].fields[].values list    
attributes.named[].fields[].values[] string, or number, or boolean, or null    
attributes.named[].fields[].what string    
attributes.named[].mechanisms list    
attributes.named[].mechanisms[] string    
attributes.named[].name string    
attributes.named[].namedBy object    
attributes.named[].namedBy.applications list    
attributes.named[].namedBy.applications[] string    
attributes.named[].namedBy.groups list    
attributes.named[].namedBy.groups[] string    
attributes.named[].namedBy.people list    
attributes.named[].namedBy.people[] string    
attributes.named[].namedBy.peopleComplete boolean    
attributes.named[].precedence integer    
attributes.named[].registrationAlgorithms list    
attributes.named[].registrationAlgorithms[] string    
attributes.named[].registrationMode string    
attributes.named[].rules list    
attributes.named[].rules[] string    
attributes.named[].secondFactors list    
attributes.named[].secondFactors[] string    
attributes.named[].selectApplications list    
attributes.named[].selectApplications[] string    
attributes.named[].selectGroups list    
attributes.named[].selectGroups[] string    
attributes.profile object    
attributes.profile.description string    
attributes.profile.dn string    
attributes.profile.enforced boolean    
attributes.profile.from string    
attributes.profile.inherited boolean    
attributes.profile.name string    
attributes.profile.precedence integer    
attributes.profile.problems list    
attributes.profile.problems[] string    
attributes.profile.required list    
attributes.profile.required[] string    
attributes.profile.requiredAttributes list, or string, or number, or boolean, or null    
attributes.profile.requiredAttributes[] string, or number, or boolean, or null    
attributes.profile.sources map    
attributes.profile.sources.{key} string    
attributes.profile.stored boolean    
attributes.references map    
attributes.references.{key} string    
attributes.required list    
attributes.required[] string    
attributes.rules list    
attributes.rules[] string    
attributes.schema object    
attributes.schema.attributes list    
attributes.schema.attributes[].name string    
attributes.schema.attributes[].what string    
attributes.schema.container string    
attributes.schema.definitionContainer string    
attributes.schema.objectClasses list    
attributes.schema.objectClasses[].name string    
attributes.schema.objectClasses[].what string    
attributes.schema.personAttributes list    
attributes.schema.personAttributes[].name string    
attributes.schema.personAttributes[].what string    
attributes.selectors list    
attributes.selectors[] string    
attributes.syntaxes list    
attributes.syntaxes[].id string    
attributes.syntaxes[].what string    
authn object    
authn.defaults map    
authn.defaults.{key} list, or string, or number, or boolean, or null    
authn.defaults.{key}[] string, or number, or boolean, or null    
authn.fields list    
authn.fields[].attribute string    
authn.fields[].default list, or string, or number, or boolean, or null    
authn.fields[].default[] string, or number, or boolean, or null    
authn.fields[].disabled boolean    
authn.fields[].disabledWhy string    
authn.fields[].email boolean    
authn.fields[].empty string    
authn.fields[].key string    
authn.fields[].label string    
authn.fields[].max number    
authn.fields[].mechanism string    
authn.fields[].min number    
authn.fields[].role string    
authn.fields[].source string, or null    
authn.fields[].type string    
authn.fields[].unit string    
authn.fields[].value list, or string, or number, or boolean, or null    
authn.fields[].value[] string, or number, or boolean, or null    
authn.fields[].values list    
authn.fields[].values[] string, or number, or boolean, or null    
authn.fields[].what string    
authn.from string    
authn.inherited boolean    
authn.mail object    
authn.mail.usable boolean    
authn.mail.why string    
authn.mechanisms list    
authn.mechanisms[].active boolean    
authn.mechanisms[].email boolean    
authn.mechanisms[].id string    
authn.mechanisms[].label string    
authn.mechanisms[].primary boolean, or null    
authn.mechanisms[].secondFactor boolean, or null    
authn.mechanisms[].what string    
authn.named list    
authn.named[].description string    
authn.named[].dn string    
authn.named[].fields list    
authn.named[].fields[].attribute string    
authn.named[].fields[].default list, or string, or number, or boolean, or null    
authn.named[].fields[].default[] string, or number, or boolean, or null    
authn.named[].fields[].disabled boolean    
authn.named[].fields[].disabledWhy string    
authn.named[].fields[].email boolean    
authn.named[].fields[].empty string    
authn.named[].fields[].key string    
authn.named[].fields[].label string    
authn.named[].fields[].max number    
authn.named[].fields[].mechanism string    
authn.named[].fields[].min number    
authn.named[].fields[].role string    
authn.named[].fields[].source string, or null    
authn.named[].fields[].type string    
authn.named[].fields[].unit string    
authn.named[].fields[].value list, or string, or number, or boolean, or null    
authn.named[].fields[].value[] string, or number, or boolean, or null    
authn.named[].fields[].values list    
authn.named[].fields[].values[] string, or number, or boolean, or null    
authn.named[].fields[].what string    
authn.named[].mechanisms list    
authn.named[].mechanisms[] string    
authn.named[].name string    
authn.named[].namedBy object    
authn.named[].namedBy.applications list    
authn.named[].namedBy.applications[] string    
authn.named[].namedBy.groups list    
authn.named[].namedBy.groups[] string    
authn.named[].namedBy.people list    
authn.named[].namedBy.people[] string    
authn.named[].namedBy.peopleComplete boolean    
authn.named[].precedence integer    
authn.named[].registrationAlgorithms list    
authn.named[].registrationAlgorithms[] string    
authn.named[].registrationMode string    
authn.named[].rules list    
authn.named[].rules[] string    
authn.named[].secondFactors list    
authn.named[].secondFactors[] string    
authn.named[].selectApplications list    
authn.named[].selectApplications[] string    
authn.named[].selectGroups list    
authn.named[].selectGroups[] string    
authn.nistWarning string    
authn.profile object    
authn.profile.certificatePrimary list, or string, or number, or boolean, or null    
authn.profile.certificatePrimary[] string, or number, or boolean, or null    
authn.profile.description string    
authn.profile.dn string    
authn.profile.emailCodeAttempts list, or string, or number, or boolean, or null    
authn.profile.emailCodeAttempts[] string, or number, or boolean, or null    
authn.profile.emailCodePrimary list, or string, or number, or boolean, or null    
authn.profile.emailCodePrimary[] string, or number, or boolean, or null    
authn.profile.emailCodeSecondFactor list, or string, or number, or boolean, or null    
authn.profile.emailCodeSecondFactor[] string, or number, or boolean, or null    
authn.profile.emailCodeTtlS list, or string, or number, or boolean, or null    
authn.profile.emailCodeTtlS[] string, or number, or boolean, or null    
authn.profile.emailFailureLimit list, or string, or number, or boolean, or null    
authn.profile.emailFailureLimit[] string, or number, or boolean, or null    
authn.profile.emailLinkPrimary list, or string, or number, or boolean, or null    
authn.profile.emailLinkPrimary[] string, or number, or boolean, or null    
authn.profile.emailLinkSecondFactor list, or string, or number, or boolean, or null    
authn.profile.emailLinkSecondFactor[] string, or number, or boolean, or null    
authn.profile.emailResendS list, or string, or number, or boolean, or null    
authn.profile.emailResendS[] string, or number, or boolean, or null    
authn.profile.enforced boolean    
authn.profile.federationPrimary list, or string, or number, or boolean, or null    
authn.profile.federationPrimary[] string, or number, or boolean, or null    
authn.profile.from string    
authn.profile.inherited boolean    
authn.profile.kerberosPrimary list, or string, or number, or boolean, or null    
authn.profile.kerberosPrimary[] string, or number, or boolean, or null    
authn.profile.name string    
authn.profile.passkeyPrimary list, or string, or number, or boolean, or null    
authn.profile.passkeyPrimary[] string, or number, or boolean, or null    
authn.profile.passwordPrimary list, or string, or number, or boolean, or null    
authn.profile.passwordPrimary[] string, or number, or boolean, or null    
authn.profile.passwordSecondFactor list, or string, or number, or boolean, or null    
authn.profile.passwordSecondFactor[] string, or number, or boolean, or null    
authn.profile.precedence integer    
authn.profile.problems list    
authn.profile.problems[] string    
authn.profile.recoveryCodeSecondFactor list, or string, or number, or boolean, or null    
authn.profile.recoveryCodeSecondFactor[] string, or number, or boolean, or null    
authn.profile.rememberedBrowserDays list, or string, or number, or boolean, or null    
authn.profile.rememberedBrowserDays[] string, or number, or boolean, or null    
authn.profile.rememberedBrowserSkipsSecondFactor list, or string, or number, or boolean, or null    
authn.profile.rememberedBrowserSkipsSecondFactor[] string, or number, or boolean, or null    
authn.profile.requireSecondFactor list, or string, or number, or boolean, or null    
authn.profile.requireSecondFactor[] string, or number, or boolean, or null    
authn.profile.requireSecondFactorForAdministrators list, or string, or number, or boolean, or null    
authn.profile.requireSecondFactorForAdministrators[] string, or number, or boolean, or null    
authn.profile.securityKeySecondFactor list, or string, or number, or boolean, or null    
authn.profile.securityKeySecondFactor[] string, or number, or boolean, or null    
authn.profile.sources map    
authn.profile.sources.{key} string    
authn.profile.stored boolean    
authn.profile.totpSecondFactor list, or string, or number, or boolean, or null    
authn.profile.totpSecondFactor[] string, or number, or boolean, or null    
authn.profile.walletPrimary list, or string, or number, or boolean, or null    
authn.profile.walletPrimary[] string, or number, or boolean, or null    
authn.profile.walletSecondFactor list, or string, or number, or boolean, or null    
authn.profile.walletSecondFactor[] string, or number, or boolean, or null    
authn.references map    
authn.references.{key} string    
authn.rules list    
authn.rules[] string    
authn.schema object    
authn.schema.attributes list    
authn.schema.attributes[].name string    
authn.schema.attributes[].what string    
authn.schema.container string    
authn.schema.definitionContainer string    
authn.schema.objectClasses list    
authn.schema.objectClasses[].name string    
authn.schema.objectClasses[].what string    
authn.schema.personAttributes list    
authn.schema.personAttributes[].name string    
authn.schema.personAttributes[].what string    
authn.selectors list    
authn.selectors[] string    
authn.vocabulary object    
authn.vocabulary.mechanisms list    
authn.vocabulary.mechanisms[] string    
authn.vocabulary.secondFactors list    
authn.vocabulary.secondFactors[] string    
enforced boolean    
enforcement string    
kinds list    
kinds[].actions list    
kinds[].actions[] string    
kinds[].container string    
kinds[].governs string    
kinds[].id string    
kinds[].label string    
kinds[].profiles integer    
kinds[].tabbed boolean    
locale object    
locale.defaults map    
locale.defaults.{key} list, or string, or number, or boolean, or null    
locale.defaults.{key}[] string, or number, or boolean, or null    
locale.fields list    
locale.fields[].attribute string    
locale.fields[].default list, or string, or number, or boolean, or null    
locale.fields[].default[] string, or number, or boolean, or null    
locale.fields[].disabled boolean    
locale.fields[].disabledWhy string    
locale.fields[].email boolean    
locale.fields[].empty string    
locale.fields[].key string    
locale.fields[].label string    
locale.fields[].max number    
locale.fields[].mechanism string    
locale.fields[].min number    
locale.fields[].role string    
locale.fields[].source string, or null    
locale.fields[].type string    
locale.fields[].unit string    
locale.fields[].value list, or string, or number, or boolean, or null    
locale.fields[].value[] string, or number, or boolean, or null    
locale.fields[].values list    
locale.fields[].values[] string, or number, or boolean, or null    
locale.fields[].what string    
locale.named list    
locale.named[].description string    
locale.named[].dn string    
locale.named[].fields list    
locale.named[].fields[].attribute string    
locale.named[].fields[].default list, or string, or number, or boolean, or null    
locale.named[].fields[].default[] string, or number, or boolean, or null    
locale.named[].fields[].disabled boolean    
locale.named[].fields[].disabledWhy string    
locale.named[].fields[].email boolean    
locale.named[].fields[].empty string    
locale.named[].fields[].key string    
locale.named[].fields[].label string    
locale.named[].fields[].max number    
locale.named[].fields[].mechanism string    
locale.named[].fields[].min number    
locale.named[].fields[].role string    
locale.named[].fields[].source string, or null    
locale.named[].fields[].type string    
locale.named[].fields[].unit string    
locale.named[].fields[].value list, or string, or number, or boolean, or null    
locale.named[].fields[].value[] string, or number, or boolean, or null    
locale.named[].fields[].values list    
locale.named[].fields[].values[] string, or number, or boolean, or null    
locale.named[].fields[].what string    
locale.named[].mechanisms list    
locale.named[].mechanisms[] string    
locale.named[].name string    
locale.named[].namedBy object    
locale.named[].namedBy.applications list    
locale.named[].namedBy.applications[] string    
locale.named[].namedBy.groups list    
locale.named[].namedBy.groups[] string    
locale.named[].namedBy.people list    
locale.named[].namedBy.people[] string    
locale.named[].namedBy.peopleComplete boolean    
locale.named[].precedence integer    
locale.named[].registrationAlgorithms list    
locale.named[].registrationAlgorithms[] string    
locale.named[].registrationMode string    
locale.named[].rules list    
locale.named[].rules[] string    
locale.named[].secondFactors list    
locale.named[].secondFactors[] string    
locale.named[].selectApplications list    
locale.named[].selectApplications[] string    
locale.named[].selectGroups list    
locale.named[].selectGroups[] string    
locale.profile object    
locale.profile.defaultLocale list, or string, or number, or boolean, or null    
locale.profile.defaultLocale[] string, or number, or boolean, or null    
locale.profile.description string    
locale.profile.dn string    
locale.profile.enforced boolean    
locale.profile.from string    
locale.profile.inherited boolean    
locale.profile.name string    
locale.profile.populatePreferredLanguage list, or string, or number, or boolean, or null    
locale.profile.populatePreferredLanguage[] string, or number, or boolean, or null    
locale.profile.precedence integer    
locale.profile.problems list    
locale.profile.problems[] string    
locale.profile.sources map    
locale.profile.sources.{key} string    
locale.profile.stored boolean    
locale.references map    
locale.references.{key} string    
locale.rules list    
locale.rules[] string    
locale.schema object    
locale.schema.attributes list    
locale.schema.attributes[].name string    
locale.schema.attributes[].what string    
locale.schema.container string    
locale.schema.definitionContainer string    
locale.schema.objectClasses list    
locale.schema.objectClasses[].name string    
locale.schema.objectClasses[].what string    
locale.schema.personAttributes list    
locale.schema.personAttributes[].name string    
locale.schema.personAttributes[].what string    
locale.selectors list    
locale.selectors[] string    
mode string    
paging object    
paging.firstRow integer    
paging.lastRow integer    
paging.noun string, or null    
paging.page integer    
paging.pages integer    
paging.param string, or null    
paging.perPage integer    
paging.total integer    
passkey object    
passkey.clients object    
passkey.clients.actions object    
passkey.clients.actions.clear string    
passkey.clients.actions.clearAll string    
passkey.clients.bound integer    
passkey.clients.learnedCount integer    
passkey.clients.learning boolean    
passkey.clients.paging object    
passkey.clients.paging.page integer    
passkey.clients.paging.pages integer    
passkey.clients.paging.per integer    
passkey.clients.paging.total integer    
passkey.clients.rows list    
passkey.clients.rows[].client string    
passkey.clients.rows[].failures integer    
passkey.clients.rows[].firstAt string    
passkey.clients.rows[].lastAt string    
passkey.clients.rows[].learned boolean    
passkey.clients.rows[].learnedAt string    
passkey.clients.rows[].learnedFailures integer    
passkey.clients.threshold integer    
passkey.clients.windowHours number    
passkey.defaults map    
passkey.defaults.{key} list, or string, or number, or boolean, or null    
passkey.defaults.{key}[] string, or number, or boolean, or null    
passkey.fields list    
passkey.fields[].attribute string    
passkey.fields[].default list, or string, or number, or boolean, or null    
passkey.fields[].default[] string, or number, or boolean, or null    
passkey.fields[].disabled boolean    
passkey.fields[].disabledWhy string    
passkey.fields[].email boolean    
passkey.fields[].empty string    
passkey.fields[].key string    
passkey.fields[].label string    
passkey.fields[].max number    
passkey.fields[].mechanism string    
passkey.fields[].min number    
passkey.fields[].role string    
passkey.fields[].source string, or null    
passkey.fields[].type string    
passkey.fields[].unit string    
passkey.fields[].value list, or string, or number, or boolean, or null    
passkey.fields[].value[] string, or number, or boolean, or null    
passkey.fields[].values list    
passkey.fields[].values[] string, or number, or boolean, or null    
passkey.fields[].what string    
passkey.named list    
passkey.named[].description string    
passkey.named[].dn string    
passkey.named[].fields list    
passkey.named[].fields[].attribute string    
passkey.named[].fields[].default list, or string, or number, or boolean, or null    
passkey.named[].fields[].default[] string, or number, or boolean, or null    
passkey.named[].fields[].disabled boolean    
passkey.named[].fields[].disabledWhy string    
passkey.named[].fields[].email boolean    
passkey.named[].fields[].empty string    
passkey.named[].fields[].key string    
passkey.named[].fields[].label string    
passkey.named[].fields[].max number    
passkey.named[].fields[].mechanism string    
passkey.named[].fields[].min number    
passkey.named[].fields[].role string    
passkey.named[].fields[].source string, or null    
passkey.named[].fields[].type string    
passkey.named[].fields[].unit string    
passkey.named[].fields[].value list, or string, or number, or boolean, or null    
passkey.named[].fields[].value[] string, or number, or boolean, or null    
passkey.named[].fields[].values list    
passkey.named[].fields[].values[] string, or number, or boolean, or null    
passkey.named[].fields[].what string    
passkey.named[].mechanisms list    
passkey.named[].mechanisms[] string    
passkey.named[].name string    
passkey.named[].namedBy object    
passkey.named[].namedBy.applications list    
passkey.named[].namedBy.applications[] string    
passkey.named[].namedBy.groups list    
passkey.named[].namedBy.groups[] string    
passkey.named[].namedBy.people list    
passkey.named[].namedBy.people[] string    
passkey.named[].namedBy.peopleComplete boolean    
passkey.named[].precedence integer    
passkey.named[].registrationAlgorithms list    
passkey.named[].registrationAlgorithms[] string    
passkey.named[].registrationMode string    
passkey.named[].rules list    
passkey.named[].rules[] string    
passkey.named[].secondFactors list    
passkey.named[].secondFactors[] string    
passkey.named[].selectApplications list    
passkey.named[].selectApplications[] string    
passkey.named[].selectGroups list    
passkey.named[].selectGroups[] string    
passkey.profile object    
passkey.profile.adminEnrolment list, or string, or number, or boolean, or null    
passkey.profile.adminEnrolment[] string, or number, or boolean, or null    
passkey.profile.aggregateDevices list, or string, or number, or boolean, or null    
passkey.profile.aggregateDevices[] string, or number, or boolean, or null    
passkey.profile.allowUsernameless list, or string, or number, or boolean, or null    
passkey.profile.allowUsernameless[] string, or number, or boolean, or null    
passkey.profile.attestationAlgorithms list, or string, or number, or boolean, or null    
passkey.profile.attestationAlgorithms[] string, or number, or boolean, or null    
passkey.profile.backupEligibility list, or string, or number, or boolean, or null    
passkey.profile.backupEligibility[] string, or number, or boolean, or null    
passkey.profile.clientRules list, or string, or number, or boolean, or null    
passkey.profile.clientRules[] string, or number, or boolean, or null    
passkey.profile.credentialLabel list, or string, or number, or boolean, or null    
passkey.profile.credentialLabel[] string, or number, or boolean, or null    
passkey.profile.description string    
passkey.profile.deviceBoundRequired list, or string, or number, or boolean, or null    
passkey.profile.deviceBoundRequired[] string, or number, or boolean, or null    
passkey.profile.dn string    
passkey.profile.enforceAttestationAtSignIn list, or string, or number, or boolean, or null    
passkey.profile.enforceAttestationAtSignIn[] string, or number, or boolean, or null    
passkey.profile.enforcePinLength list, or string, or number, or boolean, or null    
passkey.profile.enforcePinLength[] string, or number, or boolean, or null    
passkey.profile.enforced boolean    
passkey.profile.enterpriseSerialAttribute list, or string, or number, or boolean, or null    
passkey.profile.enterpriseSerialAttribute[] string, or number, or boolean, or null    
passkey.profile.from string    
passkey.profile.inherited boolean    
passkey.profile.lanes list, or string, or number, or boolean, or null    
passkey.profile.lanes[] string, or number, or boolean, or null    
passkey.profile.minPinLength list, or string, or number, or boolean, or null    
passkey.profile.minPinLength[] string, or number, or boolean, or null    
passkey.profile.name string    
passkey.profile.passkeyHints list, or string, or number, or boolean, or null    
passkey.profile.passkeyHints[] string, or number, or boolean, or null    
passkey.profile.pinLengthOnlyIfSupported list, or string, or number, or boolean, or null    
passkey.profile.pinLengthOnlyIfSupported[] string, or number, or boolean, or null    
passkey.profile.postQuantumAllowCredentials list, or string, or number, or boolean, or null    
passkey.profile.postQuantumAllowCredentials[] string, or number, or boolean, or null    
passkey.profile.postQuantumRequired list, or string, or number, or boolean, or null    
passkey.profile.postQuantumRequired[] string, or number, or boolean, or null    
passkey.profile.precedence integer    
passkey.profile.problems list    
passkey.profile.problems[] string    
passkey.profile.recoveryAssurance list, or string, or number, or boolean, or null    
passkey.profile.recoveryAssurance[] string, or number, or boolean, or null    
passkey.profile.registrationAlgorithms list, or string, or number, or boolean, or null    
passkey.profile.registrationAlgorithms[] string, or number, or boolean, or null    
passkey.profile.registrationMode list, or string, or number, or boolean, or null    
passkey.profile.registrationMode[] string, or number, or boolean, or null    
passkey.profile.requireUsernameless list, or string, or number, or boolean, or null    
passkey.profile.requireUsernameless[] string, or number, or boolean, or null    
passkey.profile.rpNameExtras list, or string, or number, or boolean, or null    
passkey.profile.rpNameExtras[] string, or number, or boolean, or null    
passkey.profile.securityKeyHints list, or string, or number, or boolean, or null    
passkey.profile.securityKeyHints[] string, or number, or boolean, or null    
passkey.profile.securityKeyResidentKey list, or string, or number, or boolean, or null    
passkey.profile.securityKeyResidentKey[] string, or number, or boolean, or null    
passkey.profile.signInHints list, or string, or number, or boolean, or null    
passkey.profile.signInHints[] string, or number, or boolean, or null    
passkey.profile.sources map    
passkey.profile.sources.{key} string    
passkey.profile.stored boolean    
passkey.profile.userDisplayName list, or string, or number, or boolean, or null    
passkey.profile.userDisplayName[] string, or number, or boolean, or null    
passkey.references map    
passkey.references.{key} string    
passkey.rules list    
passkey.rules[] string    
passkey.schema object    
passkey.schema.attributes list    
passkey.schema.attributes[].name string    
passkey.schema.attributes[].what string    
passkey.schema.container string    
passkey.schema.definitionContainer string    
passkey.schema.objectClasses list    
passkey.schema.objectClasses[].name string    
passkey.schema.objectClasses[].what string    
passkey.schema.personAttributes list    
passkey.schema.personAttributes[].name string    
passkey.schema.personAttributes[].what string    
passkey.selectors list    
passkey.selectors[] string    
password object    
password.defaults map    
password.defaults.{key} list, or string, or number, or boolean, or null    
password.defaults.{key}[] string, or number, or boolean, or null    
password.doors list    
password.doors[].door string    
password.doors[].via string    
password.fields list    
password.fields[].attribute string    
password.fields[].default list, or string, or number, or boolean, or null    
password.fields[].default[] string, or number, or boolean, or null    
password.fields[].disabled boolean    
password.fields[].disabledWhy string    
password.fields[].email boolean    
password.fields[].empty string    
password.fields[].key string    
password.fields[].label string    
password.fields[].max number    
password.fields[].mechanism string    
password.fields[].min number    
password.fields[].role string    
password.fields[].source string, or null    
password.fields[].type string    
password.fields[].unit string    
password.fields[].value list, or string, or number, or boolean, or null    
password.fields[].value[] string, or number, or boolean, or null    
password.fields[].values list    
password.fields[].values[] string, or number, or boolean, or null    
password.fields[].what string    
password.generator object    
password.generator.drawsUntil string    
password.generator.excluded list    
password.generator.excluded[] string    
password.generator.module string    
password.generator.pools list    
password.generator.pools[] string    
password.generator.source string    
password.generator.version string    
password.named list    
password.named[].description string    
password.named[].dn string    
password.named[].fields list    
password.named[].fields[].attribute string    
password.named[].fields[].default list, or string, or number, or boolean, or null    
password.named[].fields[].default[] string, or number, or boolean, or null    
password.named[].fields[].disabled boolean    
password.named[].fields[].disabledWhy string    
password.named[].fields[].email boolean    
password.named[].fields[].empty string    
password.named[].fields[].key string    
password.named[].fields[].label string    
password.named[].fields[].max number    
password.named[].fields[].mechanism string    
password.named[].fields[].min number    
password.named[].fields[].role string    
password.named[].fields[].source string, or null    
password.named[].fields[].type string    
password.named[].fields[].unit string    
password.named[].fields[].value list, or string, or number, or boolean, or null    
password.named[].fields[].value[] string, or number, or boolean, or null    
password.named[].fields[].values list    
password.named[].fields[].values[] string, or number, or boolean, or null    
password.named[].fields[].what string    
password.named[].mechanisms list    
password.named[].mechanisms[] string    
password.named[].name string    
password.named[].namedBy object    
password.named[].namedBy.applications list    
password.named[].namedBy.applications[] string    
password.named[].namedBy.groups list    
password.named[].namedBy.groups[] string    
password.named[].namedBy.people list    
password.named[].namedBy.people[] string    
password.named[].namedBy.peopleComplete boolean    
password.named[].precedence integer    
password.named[].registrationAlgorithms list    
password.named[].registrationAlgorithms[] string    
password.named[].registrationMode string    
password.named[].rules list    
password.named[].rules[] string    
password.named[].secondFactors list    
password.named[].secondFactors[] string    
password.named[].selectApplications list    
password.named[].selectApplications[] string    
password.named[].selectGroups list    
password.named[].selectGroups[] string    
password.notDoors string    
password.profile object    
password.profile.argon2Iterations list, or string, or number, or boolean, or null    
password.profile.argon2Iterations[] string, or number, or boolean, or null    
password.profile.argon2Memory list, or string, or number, or boolean, or null    
password.profile.argon2Memory[] string, or number, or boolean, or null    
password.profile.argon2Parallelism list, or string, or number, or boolean, or null    
password.profile.argon2Parallelism[] string, or number, or boolean, or null    
password.profile.description string    
password.profile.dn string    
password.profile.enforced boolean    
password.profile.from string    
password.profile.generatedLength list, or string, or number, or boolean, or null    
password.profile.generatedLength[] string, or number, or boolean, or null    
password.profile.hashAlgorithm list, or string, or number, or boolean, or null    
password.profile.hashAlgorithm[] string, or number, or boolean, or null    
password.profile.history list, or string, or number, or boolean, or null    
password.profile.history[] string, or number, or boolean, or null    
password.profile.inherited boolean    
password.profile.minLength list, or string, or number, or boolean, or null    
password.profile.minLength[] string, or number, or boolean, or null    
password.profile.minSymbols list, or string, or number, or boolean, or null    
password.profile.minSymbols[] string, or number, or boolean, or null    
password.profile.name string    
password.profile.precedence integer    
password.profile.problems list    
password.profile.problems[] string    
password.profile.requireDigit list, or string, or number, or boolean, or null    
password.profile.requireDigit[] string, or number, or boolean, or null    
password.profile.requireUppercase list, or string, or number, or boolean, or null    
password.profile.requireUppercase[] string, or number, or boolean, or null    
password.profile.scryptBlockSize list, or string, or number, or boolean, or null    
password.profile.scryptBlockSize[] string, or number, or boolean, or null    
password.profile.scryptLogN list, or string, or number, or boolean, or null    
password.profile.scryptLogN[] string, or number, or boolean, or null    
password.profile.scryptParallelism list, or string, or number, or boolean, or null    
password.profile.scryptParallelism[] string, or number, or boolean, or null    
password.profile.sources map    
password.profile.sources.{key} string    
password.profile.stored boolean    
password.references map    
password.references.{key} string    
password.rules list    
password.rules[] string    
password.schema object    
password.schema.attributes list    
password.schema.attributes[].name string    
password.schema.attributes[].what string    
password.schema.container string    
password.schema.definitionContainer string    
password.schema.objectClasses list    
password.schema.objectClasses[].name string    
password.schema.objectClasses[].what string    
password.schema.personAttributes list    
password.schema.personAttributes[].name string    
password.schema.personAttributes[].what string    
password.selectors list    
password.selectors[] string    
postLogin object    
postLogin.defaults map    
postLogin.defaults.{key} list, or string, or number, or boolean, or null    
postLogin.defaults.{key}[] string, or number, or boolean, or null    
postLogin.fields list    
postLogin.fields[].attribute string    
postLogin.fields[].default list, or string, or number, or boolean, or null    
postLogin.fields[].default[] string, or number, or boolean, or null    
postLogin.fields[].disabled boolean    
postLogin.fields[].disabledWhy string    
postLogin.fields[].email boolean    
postLogin.fields[].empty string    
postLogin.fields[].key string    
postLogin.fields[].label string    
postLogin.fields[].max number    
postLogin.fields[].mechanism string    
postLogin.fields[].min number    
postLogin.fields[].role string    
postLogin.fields[].source string, or null    
postLogin.fields[].type string    
postLogin.fields[].unit string    
postLogin.fields[].value list, or string, or number, or boolean, or null    
postLogin.fields[].value[] string, or number, or boolean, or null    
postLogin.fields[].values list    
postLogin.fields[].values[] string, or number, or boolean, or null    
postLogin.fields[].what string    
postLogin.named list    
postLogin.named[].description string    
postLogin.named[].dn string    
postLogin.named[].fields list    
postLogin.named[].fields[].attribute string    
postLogin.named[].fields[].default list, or string, or number, or boolean, or null    
postLogin.named[].fields[].default[] string, or number, or boolean, or null    
postLogin.named[].fields[].disabled boolean    
postLogin.named[].fields[].disabledWhy string    
postLogin.named[].fields[].email boolean    
postLogin.named[].fields[].empty string    
postLogin.named[].fields[].key string    
postLogin.named[].fields[].label string    
postLogin.named[].fields[].max number    
postLogin.named[].fields[].mechanism string    
postLogin.named[].fields[].min number    
postLogin.named[].fields[].role string    
postLogin.named[].fields[].source string, or null    
postLogin.named[].fields[].type string    
postLogin.named[].fields[].unit string    
postLogin.named[].fields[].value list, or string, or number, or boolean, or null    
postLogin.named[].fields[].value[] string, or number, or boolean, or null    
postLogin.named[].fields[].values list    
postLogin.named[].fields[].values[] string, or number, or boolean, or null    
postLogin.named[].fields[].what string    
postLogin.named[].mechanisms list    
postLogin.named[].mechanisms[] string    
postLogin.named[].name string    
postLogin.named[].namedBy object    
postLogin.named[].namedBy.applications list    
postLogin.named[].namedBy.applications[] string    
postLogin.named[].namedBy.groups list    
postLogin.named[].namedBy.groups[] string    
postLogin.named[].namedBy.people list    
postLogin.named[].namedBy.people[] string    
postLogin.named[].namedBy.peopleComplete boolean    
postLogin.named[].precedence integer    
postLogin.named[].registrationAlgorithms list    
postLogin.named[].registrationAlgorithms[] string    
postLogin.named[].registrationMode string    
postLogin.named[].rules list    
postLogin.named[].rules[] string    
postLogin.named[].secondFactors list    
postLogin.named[].secondFactors[] string    
postLogin.named[].selectApplications list    
postLogin.named[].selectApplications[] string    
postLogin.named[].selectGroups list    
postLogin.named[].selectGroups[] string    
postLogin.profile object    
postLogin.profile.activity list, or string, or number, or boolean, or null    
postLogin.profile.activity[] string, or number, or boolean, or null    
postLogin.profile.attestation list, or string, or number, or boolean, or null    
postLogin.profile.attestation[] string, or number, or boolean, or null    
postLogin.profile.description string    
postLogin.profile.dn string    
postLogin.profile.enabled list, or string, or number, or boolean, or null    
postLogin.profile.enabled[] string, or number, or boolean, or null    
postLogin.profile.enforced boolean    
postLogin.profile.from string    
postLogin.profile.graceDays list, or string, or number, or boolean, or null    
postLogin.profile.graceDays[] string, or number, or boolean, or null    
postLogin.profile.inherited boolean    
postLogin.profile.method list, or string, or number, or boolean, or null    
postLogin.profile.method[] string, or number, or boolean, or null    
postLogin.profile.name string    
postLogin.profile.noPasskey list, or string, or number, or boolean, or null    
postLogin.profile.noPasskey[] string, or number, or boolean, or null    
postLogin.profile.noPasskeyFallback list, or string, or number, or boolean, or null    
postLogin.profile.noPasskeyFallback[] string, or number, or boolean, or null    
postLogin.profile.precedence integer    
postLogin.profile.problems list    
postLogin.profile.problems[] string    
postLogin.profile.snoozeDays list, or string, or number, or boolean, or null    
postLogin.profile.snoozeDays[] string, or number, or boolean, or null    
postLogin.profile.sources map    
postLogin.profile.sources.{key} string    
postLogin.profile.stored boolean    
postLogin.references map    
postLogin.references.{key} string    
postLogin.rules list    
postLogin.rules[] string    
postLogin.schema object    
postLogin.schema.attributes list    
postLogin.schema.attributes[].name string    
postLogin.schema.attributes[].what string    
postLogin.schema.container string    
postLogin.schema.definitionContainer string    
postLogin.schema.objectClasses list    
postLogin.schema.objectClasses[].name string    
postLogin.schema.objectClasses[].what string    
postLogin.schema.personAttributes list    
postLogin.schema.personAttributes[].name string    
postLogin.schema.personAttributes[].what string    
postLogin.selectors list    
postLogin.selectors[] string    
profiles list    
profiles[].dn string    
profiles[].inherited boolean    
profiles[].kind string    
profiles[].name string    
profiles[].problems list    
profiles[].problems[] string    
profiles[].stored boolean    
serviceAccount object    
serviceAccount.defaults map    
serviceAccount.defaults.{key} list, or string, or number, or boolean, or null    
serviceAccount.defaults.{key}[] string, or number, or boolean, or null    
serviceAccount.fields list    
serviceAccount.fields[].attribute string    
serviceAccount.fields[].default list, or string, or number, or boolean, or null    
serviceAccount.fields[].default[] string, or number, or boolean, or null    
serviceAccount.fields[].disabled boolean    
serviceAccount.fields[].disabledWhy string    
serviceAccount.fields[].email boolean    
serviceAccount.fields[].empty string    
serviceAccount.fields[].key string    
serviceAccount.fields[].label string    
serviceAccount.fields[].max number    
serviceAccount.fields[].mechanism string    
serviceAccount.fields[].min number    
serviceAccount.fields[].role string    
serviceAccount.fields[].source string, or null    
serviceAccount.fields[].type string    
serviceAccount.fields[].unit string    
serviceAccount.fields[].value list, or string, or number, or boolean, or null    
serviceAccount.fields[].value[] string, or number, or boolean, or null    
serviceAccount.fields[].values list    
serviceAccount.fields[].values[] string, or number, or boolean, or null    
serviceAccount.fields[].what string    
serviceAccount.named list    
serviceAccount.named[].description string    
serviceAccount.named[].dn string    
serviceAccount.named[].fields list    
serviceAccount.named[].fields[].attribute string    
serviceAccount.named[].fields[].default list, or string, or number, or boolean, or null    
serviceAccount.named[].fields[].default[] string, or number, or boolean, or null    
serviceAccount.named[].fields[].disabled boolean    
serviceAccount.named[].fields[].disabledWhy string    
serviceAccount.named[].fields[].email boolean    
serviceAccount.named[].fields[].empty string    
serviceAccount.named[].fields[].key string    
serviceAccount.named[].fields[].label string    
serviceAccount.named[].fields[].max number    
serviceAccount.named[].fields[].mechanism string    
serviceAccount.named[].fields[].min number    
serviceAccount.named[].fields[].role string    
serviceAccount.named[].fields[].source string, or null    
serviceAccount.named[].fields[].type string    
serviceAccount.named[].fields[].unit string    
serviceAccount.named[].fields[].value list, or string, or number, or boolean, or null    
serviceAccount.named[].fields[].value[] string, or number, or boolean, or null    
serviceAccount.named[].fields[].values list    
serviceAccount.named[].fields[].values[] string, or number, or boolean, or null    
serviceAccount.named[].fields[].what string    
serviceAccount.named[].mechanisms list    
serviceAccount.named[].mechanisms[] string    
serviceAccount.named[].name string    
serviceAccount.named[].namedBy object    
serviceAccount.named[].namedBy.applications list    
serviceAccount.named[].namedBy.applications[] string    
serviceAccount.named[].namedBy.groups list    
serviceAccount.named[].namedBy.groups[] string    
serviceAccount.named[].namedBy.people list    
serviceAccount.named[].namedBy.people[] string    
serviceAccount.named[].namedBy.peopleComplete boolean    
serviceAccount.named[].precedence integer    
serviceAccount.named[].registrationAlgorithms list    
serviceAccount.named[].registrationAlgorithms[] string    
serviceAccount.named[].registrationMode string    
serviceAccount.named[].rules list    
serviceAccount.named[].rules[] string    
serviceAccount.named[].secondFactors list    
serviceAccount.named[].secondFactors[] string    
serviceAccount.named[].selectApplications list    
serviceAccount.named[].selectApplications[] string    
serviceAccount.named[].selectGroups list    
serviceAccount.named[].selectGroups[] string    
serviceAccount.profile object    
serviceAccount.profile.allowBrowserSignIn list, or string, or number, or boolean, or null    
serviceAccount.profile.allowBrowserSignIn[] string, or number, or boolean, or null    
serviceAccount.profile.allowEst list, or string, or number, or boolean, or null    
serviceAccount.profile.allowEst[] string, or number, or boolean, or null    
serviceAccount.profile.allowKerberos list, or string, or number, or boolean, or null    
serviceAccount.profile.allowKerberos[] string, or number, or boolean, or null    
serviceAccount.profile.allowLdapBind list, or string, or number, or boolean, or null    
serviceAccount.profile.allowLdapBind[] string, or number, or boolean, or null    
serviceAccount.profile.allowPasswordGrant list, or string, or number, or boolean, or null    
serviceAccount.profile.allowPasswordGrant[] string, or number, or boolean, or null    
serviceAccount.profile.allowScim list, or string, or number, or boolean, or null    
serviceAccount.profile.allowScim[] string, or number, or boolean, or null    
serviceAccount.profile.allowSsf list, or string, or number, or boolean, or null    
serviceAccount.profile.allowSsf[] string, or number, or boolean, or null    
serviceAccount.profile.allowWsTrust list, or string, or number, or boolean, or null    
serviceAccount.profile.allowWsTrust[] string, or number, or boolean, or null    
serviceAccount.profile.description string    
serviceAccount.profile.dn string    
serviceAccount.profile.enforced boolean    
serviceAccount.profile.exemptFromSecondFactor list, or string, or number, or boolean, or null    
serviceAccount.profile.exemptFromSecondFactor[] string, or number, or boolean, or null    
serviceAccount.profile.from string    
serviceAccount.profile.generatedLength list, or string, or number, or boolean, or null    
serviceAccount.profile.generatedLength[] string, or number, or boolean, or null    
serviceAccount.profile.inherited boolean    
serviceAccount.profile.name string    
serviceAccount.profile.precedence integer    
serviceAccount.profile.problems list    
serviceAccount.profile.problems[] string    
serviceAccount.profile.requireOwner list, or string, or number, or boolean, or null    
serviceAccount.profile.requireOwner[] string, or number, or boolean, or null    
serviceAccount.profile.rotationAlarmFailures list, or string, or number, or boolean, or null    
serviceAccount.profile.rotationAlarmFailures[] string, or number, or boolean, or null    
serviceAccount.profile.rotationEnabled list, or string, or number, or boolean, or null    
serviceAccount.profile.rotationEnabled[] string, or number, or boolean, or null    
serviceAccount.profile.rotationIntervalDays list, or string, or number, or boolean, or null    
serviceAccount.profile.rotationIntervalDays[] string, or number, or boolean, or null    
serviceAccount.profile.rotationOverlapMinutes list, or string, or number, or boolean, or null    
serviceAccount.profile.rotationOverlapMinutes[] string, or number, or boolean, or null    
serviceAccount.profile.sources map    
serviceAccount.profile.sources.{key} string    
serviceAccount.profile.stored boolean    
serviceAccount.references map    
serviceAccount.references.{key} string    
serviceAccount.rules list    
serviceAccount.rules[] string    
serviceAccount.schema object    
serviceAccount.schema.attributes list    
serviceAccount.schema.attributes[].name string    
serviceAccount.schema.attributes[].what string    
serviceAccount.schema.container string    
serviceAccount.schema.definitionContainer string    
serviceAccount.schema.objectClasses list    
serviceAccount.schema.objectClasses[].name string    
serviceAccount.schema.objectClasses[].what string    
serviceAccount.schema.personAttributes list    
serviceAccount.schema.personAttributes[].name string    
serviceAccount.schema.personAttributes[].what string    
serviceAccount.selectors list    
serviceAccount.selectors[] string    

400: The answer.

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

POST /admin-api/policies/clear-passkey-client

clearPasskeyClient

Offer ML-DSA again to one learned client

Removes one entry from this realm’s learned clients (webauthn.clientLearning): a browser, system and major version that this realm stopped offering ML-DSA to at passkey registration after webauthn.clientLearningFailures registrations from it failed with NotSupportedError, and none succeeded, within webauthn.clientLearningWindowHours. The next registration from that client is offered the list as it stands, and its failures are counted afresh. client is the name exactly as the list shows it (Chrome 141 on macOS 15); one that is not listed is refused (STS-AUTHN-0477). A configured clientRules row is not changed by this.

Mirrors POST /admin/policies on the admin console.

Scope: admin:write.

Parameters

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

Request body

Member Type Required What it is
client string yes The learned client, as listed.

200: What was done, and the sentence saying so.

Member Type Required What it is
action string    
client string    
dn string    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
removed integer    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
action string    
client string    
dn string    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
removed integer    

POST /admin-api/policies/clear-passkey-clients

clearPasskeyClients

Offer ML-DSA again to every learned client

Removes every entry from this realm’s learned clients, and the failures being counted towards new ones. removed says how many entries went. A configured clientRules row is not changed by this.

Mirrors POST /admin/policies on the admin console.

Scope: admin:write.

Parameters

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

Request body

An empty object.

200: What was done, and the sentence saying so.

Member Type Required What it is
action string    
client string    
dn string    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
removed integer    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
action string    
client string    
dn string    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
removed integer    

POST /admin-api/policies/define-person-attribute

definePersonAttribute

Define a custom attribute in this realm

Writes cn=<name>,ou=attributeDefinitions in this realm’s directory: an attribute a person here may be given, with a label, a syntax its values are checked against and whether it holds several values. It is then editable on a person’s page and through /admin-api/users/*-attribute, settable at a create, and may be required by this policy. The realm’s own: not inherited from the default realm. The name is an RFC 4512 descr of at most 64 characters, and may not be a name the directory already knows, memberOf, or begin sts (STS-LDAP-0170). At most 100 per realm.

Mirrors POST /admin/policies on the admin console.

Scope: admin:write.

Parameters

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

Request body

Member Type Required What it is
description string   What it is for. Optional.
label string yes What the pages draw beside the name.
multiValued boolean, or string   Whether it holds several values (true, or multiple from a form). Default false.
name string yes The attribute’s name.
portalEditable boolean   Whether a person may change their own values there (POST /account-api/attributes). Implies portalVisible, which is stored true with it. Default false.
portalVisible boolean   Whether a person sees their own values on the user portal’s Overview (#700). Default false.
syntax one of string, integer, boolean, date, email, uri, dn   What its values are checked against. Default string.

200: What was done, and the sentence saying so.

Member Type Required What it is
definition object    
definition.description string    
definition.dn string    
definition.label string    
definition.multi boolean    
definition.name string    
definition.portalEditable boolean    
definition.portalVisible boolean    
definition.syntax string    
dn string    
errors list    
errors[] string    
holders integer    
kind string    
message string    
name string    
ok boolean yes  
removed boolean    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
definition object    
definition.description string    
definition.dn string    
definition.label string    
definition.multi boolean    
definition.name string    
definition.portalEditable boolean    
definition.portalVisible boolean    
definition.syntax string    
dn string    
errors list    
errors[] string    
holders integer    
kind string    
message string    
name string    
ok boolean yes  
removed boolean    

POST /admin-api/policies/delete-named-authn-policy

deleteNamedAuthnPolicy

Delete a named authentication policy

Deletes cn=<name>,ou=authnPolicies in this realm. Refused while an application (appAuthnPolicy) or a group (stsAuthnPolicy, #1237) of this realm names it (STS-AUTHN-0534) — it would then allow no mechanism — and for a name the realm does not hold (STS-AUTHN-0535).

Mirrors POST /admin/policies on the admin console.

Scope: admin:write.

Parameters

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

Request body

Member Type Required What it is
name string yes The policy’s name.

200: What was done, and the sentence saying so.

Member Type Required What it is
dn string    
errors list    
errors[] string    
kind string    
message string    
name string    
ok boolean yes  
policy object    
policy.description string    
policy.dn string    
policy.mechanisms list    
policy.mechanisms[] string    
policy.name string    
policy.precedence integer    
policy.secondFactors list    
policy.secondFactors[] string    
removed boolean    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
dn string    
errors list    
errors[] string    
kind string    
message string    
name string    
ok boolean yes  
policy object    
policy.description string    
policy.dn string    
policy.mechanisms list    
policy.mechanisms[] string    
policy.name string    
policy.precedence integer    
policy.secondFactors list    
policy.secondFactors[] string    
removed boolean    

POST /admin-api/policies/remove-person-attribute

removePersonAttribute

Remove a custom attribute of this realm

Deletes cn=<name>,ou=attributeDefinitions. Refused while any person in the realm holds a value of it (STS-LDAP-0172) and while this realm’s own profile requires it (STS-LDAP-0173): a definition removed from under its values would leave data no door offers again.

Mirrors POST /admin/policies on the admin console.

Scope: admin:write.

Parameters

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

Request body

Member Type Required What it is
name string yes The attribute’s name.

200: What was done, and the sentence saying so.

Member Type Required What it is
definition object    
definition.description string    
definition.dn string    
definition.label string    
definition.multi boolean    
definition.name string    
definition.portalEditable boolean    
definition.portalVisible boolean    
definition.syntax string    
dn string    
errors list    
errors[] string    
holders integer    
kind string    
message string    
name string    
ok boolean yes  
removed boolean    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
definition object    
definition.description string    
definition.dn string    
definition.label string    
definition.multi boolean    
definition.name string    
definition.portalEditable boolean    
definition.portalVisible boolean    
definition.syntax string    
dn string    
errors list    
errors[] string    
holders integer    
kind string    
message string    
name string    
ok boolean yes  
removed boolean    

POST /admin-api/policies/reset-attributes-policy

resetAttributesPolicy

Remove this realm’s attribute policy profile

Deletes this realm’s stored profile, after which the default realm’s profile where it has one, and the built-in default (givenName, sn and mail) where it has not are in force. removed: false means nothing was stored here.

Mirrors POST /admin/policies on the admin console.

Scope: admin:write.

Parameters

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

Request body (optional)

Member Type Required What it is
profile string   Which profile: default goes back to inheriting; a named one is removed.

200: Whether anything was removed, and the profile now in force.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.description string    
profile.dn string    
profile.enforced boolean    
profile.from string    
profile.inherited boolean    
profile.name string    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.required list    
profile.required[] string    
profile.requiredAttributes list, or string, or number, or boolean, or null    
profile.requiredAttributes[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
removed boolean    
rules list    
rules[] string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.description string    
profile.dn string    
profile.enforced boolean    
profile.from string    
profile.inherited boolean    
profile.name string    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.required list    
profile.required[] string    
profile.requiredAttributes list, or string, or number, or boolean, or null    
profile.requiredAttributes[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
removed boolean    
rules list    
rules[] string    

POST /admin-api/policies/reset-authn-policy

resetAuthnPolicy

Remove this realm’s authentication policy profile

Deletes this realm’s stored profile, after which the default realm’s profile where it has one, and the built-in defaults where it has not governs this realm. removed: false means nothing was stored here.

Mirrors POST /admin/policies on the admin console.

Scope: admin:write.

Parameters

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

Request body (optional)

Member Type Required What it is
profile one of default   Which profile. Only default exists.

200: Whether anything was removed, and the profile now in force.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.certificatePrimary list, or string, or number, or boolean, or null    
profile.certificatePrimary[] string, or number, or boolean, or null    
profile.description string    
profile.dn string    
profile.emailCodeAttempts list, or string, or number, or boolean, or null    
profile.emailCodeAttempts[] string, or number, or boolean, or null    
profile.emailCodePrimary list, or string, or number, or boolean, or null    
profile.emailCodePrimary[] string, or number, or boolean, or null    
profile.emailCodeSecondFactor list, or string, or number, or boolean, or null    
profile.emailCodeSecondFactor[] string, or number, or boolean, or null    
profile.emailCodeTtlS list, or string, or number, or boolean, or null    
profile.emailCodeTtlS[] string, or number, or boolean, or null    
profile.emailFailureLimit list, or string, or number, or boolean, or null    
profile.emailFailureLimit[] string, or number, or boolean, or null    
profile.emailLinkPrimary list, or string, or number, or boolean, or null    
profile.emailLinkPrimary[] string, or number, or boolean, or null    
profile.emailLinkSecondFactor list, or string, or number, or boolean, or null    
profile.emailLinkSecondFactor[] string, or number, or boolean, or null    
profile.emailResendS list, or string, or number, or boolean, or null    
profile.emailResendS[] string, or number, or boolean, or null    
profile.enforced boolean    
profile.federationPrimary list, or string, or number, or boolean, or null    
profile.federationPrimary[] string, or number, or boolean, or null    
profile.from string    
profile.inherited boolean    
profile.kerberosPrimary list, or string, or number, or boolean, or null    
profile.kerberosPrimary[] string, or number, or boolean, or null    
profile.name string    
profile.passkeyPrimary list, or string, or number, or boolean, or null    
profile.passkeyPrimary[] string, or number, or boolean, or null    
profile.passwordPrimary list, or string, or number, or boolean, or null    
profile.passwordPrimary[] string, or number, or boolean, or null    
profile.passwordSecondFactor list, or string, or number, or boolean, or null    
profile.passwordSecondFactor[] string, or number, or boolean, or null    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.recoveryCodeSecondFactor list, or string, or number, or boolean, or null    
profile.recoveryCodeSecondFactor[] string, or number, or boolean, or null    
profile.rememberedBrowserDays list, or string, or number, or boolean, or null    
profile.rememberedBrowserDays[] string, or number, or boolean, or null    
profile.rememberedBrowserSkipsSecondFactor list, or string, or number, or boolean, or null    
profile.rememberedBrowserSkipsSecondFactor[] string, or number, or boolean, or null    
profile.requireSecondFactor list, or string, or number, or boolean, or null    
profile.requireSecondFactor[] string, or number, or boolean, or null    
profile.requireSecondFactorForAdministrators list, or string, or number, or boolean, or null    
profile.requireSecondFactorForAdministrators[] string, or number, or boolean, or null    
profile.securityKeySecondFactor list, or string, or number, or boolean, or null    
profile.securityKeySecondFactor[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
profile.totpSecondFactor list, or string, or number, or boolean, or null    
profile.totpSecondFactor[] string, or number, or boolean, or null    
profile.walletPrimary list, or string, or number, or boolean, or null    
profile.walletPrimary[] string, or number, or boolean, or null    
profile.walletSecondFactor list, or string, or number, or boolean, or null    
profile.walletSecondFactor[] string, or number, or boolean, or null    
removed boolean    
rules list    
rules[] string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.certificatePrimary list, or string, or number, or boolean, or null    
profile.certificatePrimary[] string, or number, or boolean, or null    
profile.description string    
profile.dn string    
profile.emailCodeAttempts list, or string, or number, or boolean, or null    
profile.emailCodeAttempts[] string, or number, or boolean, or null    
profile.emailCodePrimary list, or string, or number, or boolean, or null    
profile.emailCodePrimary[] string, or number, or boolean, or null    
profile.emailCodeSecondFactor list, or string, or number, or boolean, or null    
profile.emailCodeSecondFactor[] string, or number, or boolean, or null    
profile.emailCodeTtlS list, or string, or number, or boolean, or null    
profile.emailCodeTtlS[] string, or number, or boolean, or null    
profile.emailFailureLimit list, or string, or number, or boolean, or null    
profile.emailFailureLimit[] string, or number, or boolean, or null    
profile.emailLinkPrimary list, or string, or number, or boolean, or null    
profile.emailLinkPrimary[] string, or number, or boolean, or null    
profile.emailLinkSecondFactor list, or string, or number, or boolean, or null    
profile.emailLinkSecondFactor[] string, or number, or boolean, or null    
profile.emailResendS list, or string, or number, or boolean, or null    
profile.emailResendS[] string, or number, or boolean, or null    
profile.enforced boolean    
profile.federationPrimary list, or string, or number, or boolean, or null    
profile.federationPrimary[] string, or number, or boolean, or null    
profile.from string    
profile.inherited boolean    
profile.kerberosPrimary list, or string, or number, or boolean, or null    
profile.kerberosPrimary[] string, or number, or boolean, or null    
profile.name string    
profile.passkeyPrimary list, or string, or number, or boolean, or null    
profile.passkeyPrimary[] string, or number, or boolean, or null    
profile.passwordPrimary list, or string, or number, or boolean, or null    
profile.passwordPrimary[] string, or number, or boolean, or null    
profile.passwordSecondFactor list, or string, or number, or boolean, or null    
profile.passwordSecondFactor[] string, or number, or boolean, or null    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.recoveryCodeSecondFactor list, or string, or number, or boolean, or null    
profile.recoveryCodeSecondFactor[] string, or number, or boolean, or null    
profile.rememberedBrowserDays list, or string, or number, or boolean, or null    
profile.rememberedBrowserDays[] string, or number, or boolean, or null    
profile.rememberedBrowserSkipsSecondFactor list, or string, or number, or boolean, or null    
profile.rememberedBrowserSkipsSecondFactor[] string, or number, or boolean, or null    
profile.requireSecondFactor list, or string, or number, or boolean, or null    
profile.requireSecondFactor[] string, or number, or boolean, or null    
profile.requireSecondFactorForAdministrators list, or string, or number, or boolean, or null    
profile.requireSecondFactorForAdministrators[] string, or number, or boolean, or null    
profile.securityKeySecondFactor list, or string, or number, or boolean, or null    
profile.securityKeySecondFactor[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
profile.totpSecondFactor list, or string, or number, or boolean, or null    
profile.totpSecondFactor[] string, or number, or boolean, or null    
profile.walletPrimary list, or string, or number, or boolean, or null    
profile.walletPrimary[] string, or number, or boolean, or null    
profile.walletSecondFactor list, or string, or number, or boolean, or null    
profile.walletSecondFactor[] string, or number, or boolean, or null    
removed boolean    
rules list    
rules[] string    

POST /admin-api/policies/reset-locale-policy

resetLocalePolicy

Remove this realm’s locale policy profile

Deletes this realm’s stored profile, after which the default realm’s profile where it has one, and the built-in defaults where it has not are in force. removed: false means nothing was stored here.

Mirrors POST /admin/policies on the admin console.

Scope: admin:write.

Parameters

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

Request body (optional)

Member Type Required What it is
profile string   Which profile: default goes back to inheriting; a named one is removed.

200: Whether anything was removed, and the profile now in force.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.defaultLocale list, or string, or number, or boolean, or null    
profile.defaultLocale[] string, or number, or boolean, or null    
profile.description string    
profile.dn string    
profile.enforced boolean    
profile.from string    
profile.inherited boolean    
profile.name string    
profile.populatePreferredLanguage list, or string, or number, or boolean, or null    
profile.populatePreferredLanguage[] string, or number, or boolean, or null    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
removed boolean    
rules list    
rules[] string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.defaultLocale list, or string, or number, or boolean, or null    
profile.defaultLocale[] string, or number, or boolean, or null    
profile.description string    
profile.dn string    
profile.enforced boolean    
profile.from string    
profile.inherited boolean    
profile.name string    
profile.populatePreferredLanguage list, or string, or number, or boolean, or null    
profile.populatePreferredLanguage[] string, or number, or boolean, or null    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
removed boolean    
rules list    
rules[] string    

POST /admin-api/policies/reset-passkey-policy

resetPasskeyPolicy

Remove this realm’s passkey policy profile

Deletes this realm’s stored profile, after which the default realm’s profile where it has one, and the built-in defaults where it has not are in force. removed: false means nothing was stored here.

Mirrors POST /admin/policies on the admin console.

Scope: admin:write.

Parameters

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

Request body (optional)

Member Type Required What it is
profile string   Which profile: default goes back to inheriting; a named one is removed.

200: Whether anything was removed, and the profile now in force.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.adminEnrolment list, or string, or number, or boolean, or null    
profile.adminEnrolment[] string, or number, or boolean, or null    
profile.aggregateDevices list, or string, or number, or boolean, or null    
profile.aggregateDevices[] string, or number, or boolean, or null    
profile.allowUsernameless list, or string, or number, or boolean, or null    
profile.allowUsernameless[] string, or number, or boolean, or null    
profile.attestationAlgorithms list, or string, or number, or boolean, or null    
profile.attestationAlgorithms[] string, or number, or boolean, or null    
profile.backupEligibility list, or string, or number, or boolean, or null    
profile.backupEligibility[] string, or number, or boolean, or null    
profile.clientRules list, or string, or number, or boolean, or null    
profile.clientRules[] string, or number, or boolean, or null    
profile.credentialLabel list, or string, or number, or boolean, or null    
profile.credentialLabel[] string, or number, or boolean, or null    
profile.description string    
profile.deviceBoundRequired list, or string, or number, or boolean, or null    
profile.deviceBoundRequired[] string, or number, or boolean, or null    
profile.dn string    
profile.enforceAttestationAtSignIn list, or string, or number, or boolean, or null    
profile.enforceAttestationAtSignIn[] string, or number, or boolean, or null    
profile.enforcePinLength list, or string, or number, or boolean, or null    
profile.enforcePinLength[] string, or number, or boolean, or null    
profile.enforced boolean    
profile.enterpriseSerialAttribute list, or string, or number, or boolean, or null    
profile.enterpriseSerialAttribute[] string, or number, or boolean, or null    
profile.from string    
profile.inherited boolean    
profile.lanes list, or string, or number, or boolean, or null    
profile.lanes[] string, or number, or boolean, or null    
profile.minPinLength list, or string, or number, or boolean, or null    
profile.minPinLength[] string, or number, or boolean, or null    
profile.name string    
profile.passkeyHints list, or string, or number, or boolean, or null    
profile.passkeyHints[] string, or number, or boolean, or null    
profile.pinLengthOnlyIfSupported list, or string, or number, or boolean, or null    
profile.pinLengthOnlyIfSupported[] string, or number, or boolean, or null    
profile.postQuantumAllowCredentials list, or string, or number, or boolean, or null    
profile.postQuantumAllowCredentials[] string, or number, or boolean, or null    
profile.postQuantumRequired list, or string, or number, or boolean, or null    
profile.postQuantumRequired[] string, or number, or boolean, or null    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.recoveryAssurance list, or string, or number, or boolean, or null    
profile.recoveryAssurance[] string, or number, or boolean, or null    
profile.registrationAlgorithms list, or string, or number, or boolean, or null    
profile.registrationAlgorithms[] string, or number, or boolean, or null    
profile.registrationMode list, or string, or number, or boolean, or null    
profile.registrationMode[] string, or number, or boolean, or null    
profile.requireUsernameless list, or string, or number, or boolean, or null    
profile.requireUsernameless[] string, or number, or boolean, or null    
profile.rpNameExtras list, or string, or number, or boolean, or null    
profile.rpNameExtras[] string, or number, or boolean, or null    
profile.securityKeyHints list, or string, or number, or boolean, or null    
profile.securityKeyHints[] string, or number, or boolean, or null    
profile.securityKeyResidentKey list, or string, or number, or boolean, or null    
profile.securityKeyResidentKey[] string, or number, or boolean, or null    
profile.signInHints list, or string, or number, or boolean, or null    
profile.signInHints[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
profile.userDisplayName list, or string, or number, or boolean, or null    
profile.userDisplayName[] string, or number, or boolean, or null    
removed boolean    
rules list    
rules[] string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.adminEnrolment list, or string, or number, or boolean, or null    
profile.adminEnrolment[] string, or number, or boolean, or null    
profile.aggregateDevices list, or string, or number, or boolean, or null    
profile.aggregateDevices[] string, or number, or boolean, or null    
profile.allowUsernameless list, or string, or number, or boolean, or null    
profile.allowUsernameless[] string, or number, or boolean, or null    
profile.attestationAlgorithms list, or string, or number, or boolean, or null    
profile.attestationAlgorithms[] string, or number, or boolean, or null    
profile.backupEligibility list, or string, or number, or boolean, or null    
profile.backupEligibility[] string, or number, or boolean, or null    
profile.clientRules list, or string, or number, or boolean, or null    
profile.clientRules[] string, or number, or boolean, or null    
profile.credentialLabel list, or string, or number, or boolean, or null    
profile.credentialLabel[] string, or number, or boolean, or null    
profile.description string    
profile.deviceBoundRequired list, or string, or number, or boolean, or null    
profile.deviceBoundRequired[] string, or number, or boolean, or null    
profile.dn string    
profile.enforceAttestationAtSignIn list, or string, or number, or boolean, or null    
profile.enforceAttestationAtSignIn[] string, or number, or boolean, or null    
profile.enforcePinLength list, or string, or number, or boolean, or null    
profile.enforcePinLength[] string, or number, or boolean, or null    
profile.enforced boolean    
profile.enterpriseSerialAttribute list, or string, or number, or boolean, or null    
profile.enterpriseSerialAttribute[] string, or number, or boolean, or null    
profile.from string    
profile.inherited boolean    
profile.lanes list, or string, or number, or boolean, or null    
profile.lanes[] string, or number, or boolean, or null    
profile.minPinLength list, or string, or number, or boolean, or null    
profile.minPinLength[] string, or number, or boolean, or null    
profile.name string    
profile.passkeyHints list, or string, or number, or boolean, or null    
profile.passkeyHints[] string, or number, or boolean, or null    
profile.pinLengthOnlyIfSupported list, or string, or number, or boolean, or null    
profile.pinLengthOnlyIfSupported[] string, or number, or boolean, or null    
profile.postQuantumAllowCredentials list, or string, or number, or boolean, or null    
profile.postQuantumAllowCredentials[] string, or number, or boolean, or null    
profile.postQuantumRequired list, or string, or number, or boolean, or null    
profile.postQuantumRequired[] string, or number, or boolean, or null    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.recoveryAssurance list, or string, or number, or boolean, or null    
profile.recoveryAssurance[] string, or number, or boolean, or null    
profile.registrationAlgorithms list, or string, or number, or boolean, or null    
profile.registrationAlgorithms[] string, or number, or boolean, or null    
profile.registrationMode list, or string, or number, or boolean, or null    
profile.registrationMode[] string, or number, or boolean, or null    
profile.requireUsernameless list, or string, or number, or boolean, or null    
profile.requireUsernameless[] string, or number, or boolean, or null    
profile.rpNameExtras list, or string, or number, or boolean, or null    
profile.rpNameExtras[] string, or number, or boolean, or null    
profile.securityKeyHints list, or string, or number, or boolean, or null    
profile.securityKeyHints[] string, or number, or boolean, or null    
profile.securityKeyResidentKey list, or string, or number, or boolean, or null    
profile.securityKeyResidentKey[] string, or number, or boolean, or null    
profile.signInHints list, or string, or number, or boolean, or null    
profile.signInHints[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
profile.userDisplayName list, or string, or number, or boolean, or null    
profile.userDisplayName[] string, or number, or boolean, or null    
removed boolean    
rules list    
rules[] string    

POST /admin-api/policies/reset-password-policy

resetPasswordPolicy

Remove this realm’s password policy profile

Deletes this realm’s stored profile, after which the built-in defaults are in force. removed: false means nothing was stored here.

Mirrors POST /admin/policies on the admin console.

Scope: admin:write.

Parameters

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

Request body (optional)

Member Type Required What it is
profile string   Which profile: default goes back to inheriting; a named one is removed.

200: Whether anything was removed, and the profile now in force.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.argon2Iterations list, or string, or number, or boolean, or null    
profile.argon2Iterations[] string, or number, or boolean, or null    
profile.argon2Memory list, or string, or number, or boolean, or null    
profile.argon2Memory[] string, or number, or boolean, or null    
profile.argon2Parallelism list, or string, or number, or boolean, or null    
profile.argon2Parallelism[] string, or number, or boolean, or null    
profile.description string    
profile.dn string    
profile.enforced boolean    
profile.from string    
profile.generatedLength list, or string, or number, or boolean, or null    
profile.generatedLength[] string, or number, or boolean, or null    
profile.hashAlgorithm list, or string, or number, or boolean, or null    
profile.hashAlgorithm[] string, or number, or boolean, or null    
profile.history list, or string, or number, or boolean, or null    
profile.history[] string, or number, or boolean, or null    
profile.inherited boolean    
profile.minLength list, or string, or number, or boolean, or null    
profile.minLength[] string, or number, or boolean, or null    
profile.minSymbols list, or string, or number, or boolean, or null    
profile.minSymbols[] string, or number, or boolean, or null    
profile.name string    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.requireDigit list, or string, or number, or boolean, or null    
profile.requireDigit[] string, or number, or boolean, or null    
profile.requireUppercase list, or string, or number, or boolean, or null    
profile.requireUppercase[] string, or number, or boolean, or null    
profile.scryptBlockSize list, or string, or number, or boolean, or null    
profile.scryptBlockSize[] string, or number, or boolean, or null    
profile.scryptLogN list, or string, or number, or boolean, or null    
profile.scryptLogN[] string, or number, or boolean, or null    
profile.scryptParallelism list, or string, or number, or boolean, or null    
profile.scryptParallelism[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
removed boolean    
rules list    
rules[] string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.argon2Iterations list, or string, or number, or boolean, or null    
profile.argon2Iterations[] string, or number, or boolean, or null    
profile.argon2Memory list, or string, or number, or boolean, or null    
profile.argon2Memory[] string, or number, or boolean, or null    
profile.argon2Parallelism list, or string, or number, or boolean, or null    
profile.argon2Parallelism[] string, or number, or boolean, or null    
profile.description string    
profile.dn string    
profile.enforced boolean    
profile.from string    
profile.generatedLength list, or string, or number, or boolean, or null    
profile.generatedLength[] string, or number, or boolean, or null    
profile.hashAlgorithm list, or string, or number, or boolean, or null    
profile.hashAlgorithm[] string, or number, or boolean, or null    
profile.history list, or string, or number, or boolean, or null    
profile.history[] string, or number, or boolean, or null    
profile.inherited boolean    
profile.minLength list, or string, or number, or boolean, or null    
profile.minLength[] string, or number, or boolean, or null    
profile.minSymbols list, or string, or number, or boolean, or null    
profile.minSymbols[] string, or number, or boolean, or null    
profile.name string    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.requireDigit list, or string, or number, or boolean, or null    
profile.requireDigit[] string, or number, or boolean, or null    
profile.requireUppercase list, or string, or number, or boolean, or null    
profile.requireUppercase[] string, or number, or boolean, or null    
profile.scryptBlockSize list, or string, or number, or boolean, or null    
profile.scryptBlockSize[] string, or number, or boolean, or null    
profile.scryptLogN list, or string, or number, or boolean, or null    
profile.scryptLogN[] string, or number, or boolean, or null    
profile.scryptParallelism list, or string, or number, or boolean, or null    
profile.scryptParallelism[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
removed boolean    
rules list    
rules[] string    

POST /admin-api/policies/reset-postLogin-policy

resetPostLoginPolicy

Remove this realm’s post-login activity policy profile

Deletes this realm’s stored profile, after which the default realm’s profile where it has one, and the built-in defaults (nobody is asked anything) where it has not are in force. removed: false means nothing was stored here.

Mirrors POST /admin/policies on the admin console.

Scope: admin:write.

Parameters

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

Request body (optional)

Member Type Required What it is
profile string   Which profile: default goes back to inheriting; a named one is removed.

200: Whether anything was removed, and the profile now in force.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.activity list, or string, or number, or boolean, or null    
profile.activity[] string, or number, or boolean, or null    
profile.attestation list, or string, or number, or boolean, or null    
profile.attestation[] string, or number, or boolean, or null    
profile.description string    
profile.dn string    
profile.enabled list, or string, or number, or boolean, or null    
profile.enabled[] string, or number, or boolean, or null    
profile.enforced boolean    
profile.from string    
profile.graceDays list, or string, or number, or boolean, or null    
profile.graceDays[] string, or number, or boolean, or null    
profile.inherited boolean    
profile.method list, or string, or number, or boolean, or null    
profile.method[] string, or number, or boolean, or null    
profile.name string    
profile.noPasskey list, or string, or number, or boolean, or null    
profile.noPasskey[] string, or number, or boolean, or null    
profile.noPasskeyFallback list, or string, or number, or boolean, or null    
profile.noPasskeyFallback[] string, or number, or boolean, or null    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.snoozeDays list, or string, or number, or boolean, or null    
profile.snoozeDays[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
removed boolean    
rules list    
rules[] string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.activity list, or string, or number, or boolean, or null    
profile.activity[] string, or number, or boolean, or null    
profile.attestation list, or string, or number, or boolean, or null    
profile.attestation[] string, or number, or boolean, or null    
profile.description string    
profile.dn string    
profile.enabled list, or string, or number, or boolean, or null    
profile.enabled[] string, or number, or boolean, or null    
profile.enforced boolean    
profile.from string    
profile.graceDays list, or string, or number, or boolean, or null    
profile.graceDays[] string, or number, or boolean, or null    
profile.inherited boolean    
profile.method list, or string, or number, or boolean, or null    
profile.method[] string, or number, or boolean, or null    
profile.name string    
profile.noPasskey list, or string, or number, or boolean, or null    
profile.noPasskey[] string, or number, or boolean, or null    
profile.noPasskeyFallback list, or string, or number, or boolean, or null    
profile.noPasskeyFallback[] string, or number, or boolean, or null    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.snoozeDays list, or string, or number, or boolean, or null    
profile.snoozeDays[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
removed boolean    
rules list    
rules[] string    

POST /admin-api/policies/reset-serviceAccount-policy

resetServiceAccountPolicy

Remove this realm’s service-account policy profile

Deletes this realm’s stored profile, after which the default realm’s profile where it has one, and the built-in defaults where it has not are in force. removed: false means nothing was stored here.

Mirrors POST /admin/policies on the admin console.

Scope: admin:write.

Parameters

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

Request body (optional)

Member Type Required What it is
profile string   Which profile: default goes back to inheriting; a named one is removed.

200: Whether anything was removed, and the profile now in force.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.allowBrowserSignIn list, or string, or number, or boolean, or null    
profile.allowBrowserSignIn[] string, or number, or boolean, or null    
profile.allowEst list, or string, or number, or boolean, or null    
profile.allowEst[] string, or number, or boolean, or null    
profile.allowKerberos list, or string, or number, or boolean, or null    
profile.allowKerberos[] string, or number, or boolean, or null    
profile.allowLdapBind list, or string, or number, or boolean, or null    
profile.allowLdapBind[] string, or number, or boolean, or null    
profile.allowPasswordGrant list, or string, or number, or boolean, or null    
profile.allowPasswordGrant[] string, or number, or boolean, or null    
profile.allowScim list, or string, or number, or boolean, or null    
profile.allowScim[] string, or number, or boolean, or null    
profile.allowSsf list, or string, or number, or boolean, or null    
profile.allowSsf[] string, or number, or boolean, or null    
profile.allowWsTrust list, or string, or number, or boolean, or null    
profile.allowWsTrust[] string, or number, or boolean, or null    
profile.description string    
profile.dn string    
profile.enforced boolean    
profile.exemptFromSecondFactor list, or string, or number, or boolean, or null    
profile.exemptFromSecondFactor[] string, or number, or boolean, or null    
profile.from string    
profile.generatedLength list, or string, or number, or boolean, or null    
profile.generatedLength[] string, or number, or boolean, or null    
profile.inherited boolean    
profile.name string    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.requireOwner list, or string, or number, or boolean, or null    
profile.requireOwner[] string, or number, or boolean, or null    
profile.rotationAlarmFailures list, or string, or number, or boolean, or null    
profile.rotationAlarmFailures[] string, or number, or boolean, or null    
profile.rotationEnabled list, or string, or number, or boolean, or null    
profile.rotationEnabled[] string, or number, or boolean, or null    
profile.rotationIntervalDays list, or string, or number, or boolean, or null    
profile.rotationIntervalDays[] string, or number, or boolean, or null    
profile.rotationOverlapMinutes list, or string, or number, or boolean, or null    
profile.rotationOverlapMinutes[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
removed boolean    
rules list    
rules[] string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.allowBrowserSignIn list, or string, or number, or boolean, or null    
profile.allowBrowserSignIn[] string, or number, or boolean, or null    
profile.allowEst list, or string, or number, or boolean, or null    
profile.allowEst[] string, or number, or boolean, or null    
profile.allowKerberos list, or string, or number, or boolean, or null    
profile.allowKerberos[] string, or number, or boolean, or null    
profile.allowLdapBind list, or string, or number, or boolean, or null    
profile.allowLdapBind[] string, or number, or boolean, or null    
profile.allowPasswordGrant list, or string, or number, or boolean, or null    
profile.allowPasswordGrant[] string, or number, or boolean, or null    
profile.allowScim list, or string, or number, or boolean, or null    
profile.allowScim[] string, or number, or boolean, or null    
profile.allowSsf list, or string, or number, or boolean, or null    
profile.allowSsf[] string, or number, or boolean, or null    
profile.allowWsTrust list, or string, or number, or boolean, or null    
profile.allowWsTrust[] string, or number, or boolean, or null    
profile.description string    
profile.dn string    
profile.enforced boolean    
profile.exemptFromSecondFactor list, or string, or number, or boolean, or null    
profile.exemptFromSecondFactor[] string, or number, or boolean, or null    
profile.from string    
profile.generatedLength list, or string, or number, or boolean, or null    
profile.generatedLength[] string, or number, or boolean, or null    
profile.inherited boolean    
profile.name string    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.requireOwner list, or string, or number, or boolean, or null    
profile.requireOwner[] string, or number, or boolean, or null    
profile.rotationAlarmFailures list, or string, or number, or boolean, or null    
profile.rotationAlarmFailures[] string, or number, or boolean, or null    
profile.rotationEnabled list, or string, or number, or boolean, or null    
profile.rotationEnabled[] string, or number, or boolean, or null    
profile.rotationIntervalDays list, or string, or number, or boolean, or null    
profile.rotationIntervalDays[] string, or number, or boolean, or null    
profile.rotationOverlapMinutes list, or string, or number, or boolean, or null    
profile.rotationOverlapMinutes[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
removed boolean    
rules list    
rules[] string    

POST /admin-api/policies/save-attributes-policy

saveAttributesPolicy

Set the attribute policy profile

Writes cn=default,ou=attributePolicies in this realm’s directory, REPLACING what is there; a realm with no entry of its own follows the default realm’s, and the built-in default is givenName, sn, mail. requiredAttributes is the list (an array, or comma-separated) of attributes every person must hold besides uid, cn and sn, which are always required; a name a person here cannot be given a value for — userPassword, a binary attribute, memberOf, an sts attribute, or a custom attribute this realm does not define — is refused (STS-LDAP-0166). Enforced in product mode: a create without one is refused at every door (STS-LDAP-0162), and an edit may not take one away (STS-LDAP-0164). GET /admin-api/policies?missing=count counts the people who lack one, where the directory is held in memory.

Every field is required and one left out is refused by name rather than reset to a default, because a save that quietly loosened a rule nobody mentioned is the mistake nobody sees.

Mirrors POST /admin/policies on the admin console.

Scope: admin:write.

Parameters

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

Request body

Member Type Required What it is
description string   What the profile is for, for the next person. Optional.
precedence integer, or string   A named profile only: the lowest matching precedence wins. Default 100.
profile string   Which profile: default, or a named profile (lower-case letters, digits and hyphens), which is created by its first save.
requiredAttributes list, or string yes  
requiredAttributes[] string    

200: The profile now in force and the rules as sentences.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.description string    
profile.dn string    
profile.enforced boolean    
profile.from string    
profile.inherited boolean    
profile.name string    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.required list    
profile.required[] string    
profile.requiredAttributes list, or string, or number, or boolean, or null    
profile.requiredAttributes[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
removed boolean    
rules list    
rules[] string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.description string    
profile.dn string    
profile.enforced boolean    
profile.from string    
profile.inherited boolean    
profile.name string    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.required list    
profile.required[] string    
profile.requiredAttributes list, or string, or number, or boolean, or null    
profile.requiredAttributes[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
removed boolean    
rules list    
rules[] string    

POST /admin-api/policies/save-authn-policy

saveAuthnPolicy

Set the authentication policy profile

Writes cn=default,ou=authnPolicies in this realm’s directory, REPLACING what is there — in the DEFAULT realm, the profile every realm without its own follows. At least one mechanism must be a first factor, and with requireSecondFactor: always at least one a second. An email mechanism cannot be turned on while this realm cannot send mail (STS-AUTHN-0244), and NIST SP 800-63B-4 section 3.1.3.1 advises against email as an authenticator at all, which is why both are off by default. There is no never: a person who holds a second factor is always asked for it.

Every field is required and one left out is refused by name rather than reset to a default, because a save that quietly loosened a rule nobody mentioned is the mistake nobody sees. The only profile is default: nothing assigns a profile to a person, so another name is refused rather than stored.

Mirrors POST /admin/policies on the admin console.

Scope: admin:write.

Parameters

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

Request body

Member Type Required What it is
certificatePrimary boolean, or string yes A verified TLS client certificate: GET /tls/sign-in, or Continue with your certificate on the sign-in screen. (true/false, or TRUE/FALSE from a form.) Default true.
description string   What the profile is for, for the next person. Optional.
emailCodeAttempts integer, or string yes How many wrong codes one sign-in step accepts before it is ended and the person starts again. The per-person and per-network rate limits apply as well. Between 1 and 10. Default 5.
emailCodePrimary boolean, or string yes A six-digit code mailed to the person’s VERIFIED address. NIST SP 800-63B-4 section 3.1.3.1: “Email SHALL NOT be used for out-of-band authentication”, because a mailbox may be reached with a password alone, and mail may be read in transit or rerouted. Off by default for that reason; turn it on only where that is an accepted risk. (true/false, or TRUE/FALSE from a form.) Default false.
emailCodeSecondFactor boolean, or string yes A six-digit code mailed to the person’s VERIFIED address. NIST SP 800-63B-4 section 3.1.3.1: “Email SHALL NOT be used for out-of-band authentication”, because a mailbox may be reached with a password alone, and mail may be read in transit or rerouted. Off by default for that reason; turn it on only where that is an accepted risk. (true/false, or TRUE/FALSE from a form.) Default false.
emailCodeTtlS integer, or string yes From the moment it is sent. At most ten minutes, NIST SP 800-63B-4 section 3.1.3.2’s bound for an out-of-band secret. Between 60 and 600. Default 300.
emailFailureLimit integer, or string yes NIST SP 800-63B-4 section 3.2.2 asks for no more than 100. The person, and their administrators, are told, and the person turns it on again from the portal. Between 5 and 100. Default 100.
emailLinkPrimary boolean, or string yes A single-use link mailed to the person’s VERIFIED address, which completes the sign-in only in the browser that started it. NIST SP 800-63B-4 section 3.1.3.1: “Email SHALL NOT be used for out-of-band authentication”, because a mailbox may be reached with a password alone, and mail may be read in transit or rerouted. Off by default for that reason; turn it on only where that is an accepted risk. (true/false, or TRUE/FALSE from a form.) Default false.
emailLinkSecondFactor boolean, or string yes A single-use link mailed to the person’s VERIFIED address, which completes the sign-in only in the browser that started it. NIST SP 800-63B-4 section 3.1.3.1: “Email SHALL NOT be used for out-of-band authentication”, because a mailbox may be reached with a password alone, and mail may be read in transit or rerouted. Off by default for that reason; turn it on only where that is an accepted risk. (true/false, or TRUE/FALSE from a form.) Default false.
emailResendS integer, or string yes A new code or link replaces the last one, which stops working. At most three are sent for one sign-in step. Between 15 and 600. Default 60.
federationPrimary boolean, or string yes A sign-in asserted by a configured federation partner. (true/false, or TRUE/FALSE from a form.) Default true.
kerberosPrimary boolean, or string yes GET /authn/spnego with a Kerberos ticket. (true/false, or TRUE/FALSE from a form.) Default true.
passkeyPrimary boolean, or string yes Any passkey (WebAuthn credential) the person holds, signing them in with no password. A passkey has no role: this row says, at each sign-in, whether any of them may be a first factor in this realm, unless the first factors of the authentication policy an application names (appAuthnPolicy) say otherwise. (true/false, or TRUE/FALSE from a form.) Default true.
passwordPrimary boolean, or string yes A password on the sign-in screen. As a SECOND factor it is the password asked for after a wallet or other passwordless first factor. (true/false, or TRUE/FALSE from a form.) Default true.
passwordSecondFactor boolean, or string yes A password on the sign-in screen. As a SECOND factor it is the password asked for after a wallet or other passwordless first factor. (true/false, or TRUE/FALSE from a form.) Default true.
profile one of default   Which profile. Only default exists.
recoveryCodeSecondFactor boolean, or string yes A single-use code from a set the person generated. Off here, no new set may be generated; a set already held still works (this row replaced backupCodes.enabled, and keeps its contract). (true/false, or TRUE/FALSE from a form.) Default true.
rememberedBrowserDays integer, or string yes Counted from the last time the person gave their second factor on that browser. After it they are asked again, and giving it starts the period again. Between 1 and 400. Default 30.
rememberedBrowserSkipsSecondFactor boolean, or string yes OFF BY DEFAULT. On, a person signing in on a browser they chose to remember is not asked for their second factor again within the period below of last giving it on that browser. NEVER at the admin console, the user portal or the protocol debugger; never for an administrator; never while the sign-in’s risk is medium or higher; and the sign-in is then ONE factor to every relying party — amr [“pwd”] and acr “1”, as a password alone — so an application asking for “mfa” is refused it. The browser is recognised by a bearer cookie: whoever copies the cookie skips the second factor too, until the copy is caught. (true/false, or TRUE/FALSE from a form.) Default false.
requireSecondFactor one of if-held, always yes if-held: a person is asked for a second factor when they hold one (or their entry says stsMfaRequired). always: everybody in this realm is, and somebody who holds none is sent to enrol one at their next sign-in. This replaced authn.mfaRequired. There is no “never”: a held factor is always asked for. Default if-held.
requireSecondFactorForAdministrators one of if-held, offer, always yes For anybody holding a console role (Admin Read or Admin Write) who holds no second factor. offer: they are shown the step that sets one up, with an Ignore button, at every sign-in. always: they must set one up before they are signed in — except the default realm’s built-in administrator (admin.bootstrapUsername), who is only ever offered one, so a service is never left with nobody who can sign in. if-held: as everybody else, by the field above. WEAKER THAN always: an administrator on a password alone is an administrator anyone with the password is. Default offer.
securityKeySecondFactor boolean, or string yes Any passkey (WebAuthn credential) the person holds, asked for after a first factor. A passkey has no role: this row says, at each sign-in, whether any of them may be a second factor in this realm, unless the second factors of the authentication policy an application names (appAuthnPolicy) say otherwise. (true/false, or TRUE/FALSE from a form.) Default true.
totpSecondFactor boolean, or string yes An RFC 6238 one-time code. Never a first factor: this service holds the same shared secret the app does. Off here, nobody may ENROL one; a person who already holds one is still asked for it, because an off switch that downgraded every enrolled account to a password alone would do something other than it says (this row replaced totp.enabled, and keeps its contract). (true/false, or TRUE/FALSE from a form.) Default true.
walletPrimary boolean, or string yes /authn/wallet with a credential this realm issued, or a SIOPv2 self-issued ID Token from an enrolled key. As a SECOND factor, the wallet presented after a password. (true/false, or TRUE/FALSE from a form.) Default true.
walletSecondFactor boolean, or string yes /authn/wallet with a credential this realm issued, or a SIOPv2 self-issued ID Token from an enrolled key. As a SECOND factor, the wallet presented after a password. (true/false, or TRUE/FALSE from a form.) Default true.

200: The profile now in force and the rules as sentences.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.certificatePrimary list, or string, or number, or boolean, or null    
profile.certificatePrimary[] string, or number, or boolean, or null    
profile.description string    
profile.dn string    
profile.emailCodeAttempts list, or string, or number, or boolean, or null    
profile.emailCodeAttempts[] string, or number, or boolean, or null    
profile.emailCodePrimary list, or string, or number, or boolean, or null    
profile.emailCodePrimary[] string, or number, or boolean, or null    
profile.emailCodeSecondFactor list, or string, or number, or boolean, or null    
profile.emailCodeSecondFactor[] string, or number, or boolean, or null    
profile.emailCodeTtlS list, or string, or number, or boolean, or null    
profile.emailCodeTtlS[] string, or number, or boolean, or null    
profile.emailFailureLimit list, or string, or number, or boolean, or null    
profile.emailFailureLimit[] string, or number, or boolean, or null    
profile.emailLinkPrimary list, or string, or number, or boolean, or null    
profile.emailLinkPrimary[] string, or number, or boolean, or null    
profile.emailLinkSecondFactor list, or string, or number, or boolean, or null    
profile.emailLinkSecondFactor[] string, or number, or boolean, or null    
profile.emailResendS list, or string, or number, or boolean, or null    
profile.emailResendS[] string, or number, or boolean, or null    
profile.enforced boolean    
profile.federationPrimary list, or string, or number, or boolean, or null    
profile.federationPrimary[] string, or number, or boolean, or null    
profile.from string    
profile.inherited boolean    
profile.kerberosPrimary list, or string, or number, or boolean, or null    
profile.kerberosPrimary[] string, or number, or boolean, or null    
profile.name string    
profile.passkeyPrimary list, or string, or number, or boolean, or null    
profile.passkeyPrimary[] string, or number, or boolean, or null    
profile.passwordPrimary list, or string, or number, or boolean, or null    
profile.passwordPrimary[] string, or number, or boolean, or null    
profile.passwordSecondFactor list, or string, or number, or boolean, or null    
profile.passwordSecondFactor[] string, or number, or boolean, or null    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.recoveryCodeSecondFactor list, or string, or number, or boolean, or null    
profile.recoveryCodeSecondFactor[] string, or number, or boolean, or null    
profile.rememberedBrowserDays list, or string, or number, or boolean, or null    
profile.rememberedBrowserDays[] string, or number, or boolean, or null    
profile.rememberedBrowserSkipsSecondFactor list, or string, or number, or boolean, or null    
profile.rememberedBrowserSkipsSecondFactor[] string, or number, or boolean, or null    
profile.requireSecondFactor list, or string, or number, or boolean, or null    
profile.requireSecondFactor[] string, or number, or boolean, or null    
profile.requireSecondFactorForAdministrators list, or string, or number, or boolean, or null    
profile.requireSecondFactorForAdministrators[] string, or number, or boolean, or null    
profile.securityKeySecondFactor list, or string, or number, or boolean, or null    
profile.securityKeySecondFactor[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
profile.totpSecondFactor list, or string, or number, or boolean, or null    
profile.totpSecondFactor[] string, or number, or boolean, or null    
profile.walletPrimary list, or string, or number, or boolean, or null    
profile.walletPrimary[] string, or number, or boolean, or null    
profile.walletSecondFactor list, or string, or number, or boolean, or null    
profile.walletSecondFactor[] string, or number, or boolean, or null    
removed boolean    
rules list    
rules[] string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.certificatePrimary list, or string, or number, or boolean, or null    
profile.certificatePrimary[] string, or number, or boolean, or null    
profile.description string    
profile.dn string    
profile.emailCodeAttempts list, or string, or number, or boolean, or null    
profile.emailCodeAttempts[] string, or number, or boolean, or null    
profile.emailCodePrimary list, or string, or number, or boolean, or null    
profile.emailCodePrimary[] string, or number, or boolean, or null    
profile.emailCodeSecondFactor list, or string, or number, or boolean, or null    
profile.emailCodeSecondFactor[] string, or number, or boolean, or null    
profile.emailCodeTtlS list, or string, or number, or boolean, or null    
profile.emailCodeTtlS[] string, or number, or boolean, or null    
profile.emailFailureLimit list, or string, or number, or boolean, or null    
profile.emailFailureLimit[] string, or number, or boolean, or null    
profile.emailLinkPrimary list, or string, or number, or boolean, or null    
profile.emailLinkPrimary[] string, or number, or boolean, or null    
profile.emailLinkSecondFactor list, or string, or number, or boolean, or null    
profile.emailLinkSecondFactor[] string, or number, or boolean, or null    
profile.emailResendS list, or string, or number, or boolean, or null    
profile.emailResendS[] string, or number, or boolean, or null    
profile.enforced boolean    
profile.federationPrimary list, or string, or number, or boolean, or null    
profile.federationPrimary[] string, or number, or boolean, or null    
profile.from string    
profile.inherited boolean    
profile.kerberosPrimary list, or string, or number, or boolean, or null    
profile.kerberosPrimary[] string, or number, or boolean, or null    
profile.name string    
profile.passkeyPrimary list, or string, or number, or boolean, or null    
profile.passkeyPrimary[] string, or number, or boolean, or null    
profile.passwordPrimary list, or string, or number, or boolean, or null    
profile.passwordPrimary[] string, or number, or boolean, or null    
profile.passwordSecondFactor list, or string, or number, or boolean, or null    
profile.passwordSecondFactor[] string, or number, or boolean, or null    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.recoveryCodeSecondFactor list, or string, or number, or boolean, or null    
profile.recoveryCodeSecondFactor[] string, or number, or boolean, or null    
profile.rememberedBrowserDays list, or string, or number, or boolean, or null    
profile.rememberedBrowserDays[] string, or number, or boolean, or null    
profile.rememberedBrowserSkipsSecondFactor list, or string, or number, or boolean, or null    
profile.rememberedBrowserSkipsSecondFactor[] string, or number, or boolean, or null    
profile.requireSecondFactor list, or string, or number, or boolean, or null    
profile.requireSecondFactor[] string, or number, or boolean, or null    
profile.requireSecondFactorForAdministrators list, or string, or number, or boolean, or null    
profile.requireSecondFactorForAdministrators[] string, or number, or boolean, or null    
profile.securityKeySecondFactor list, or string, or number, or boolean, or null    
profile.securityKeySecondFactor[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
profile.totpSecondFactor list, or string, or number, or boolean, or null    
profile.totpSecondFactor[] string, or number, or boolean, or null    
profile.walletPrimary list, or string, or number, or boolean, or null    
profile.walletPrimary[] string, or number, or boolean, or null    
profile.walletSecondFactor list, or string, or number, or boolean, or null    
profile.walletSecondFactor[] string, or number, or boolean, or null    
removed boolean    
rules list    
rules[] string    

POST /admin-api/policies/save-locale-policy

saveLocalePolicy

Set the locale policy profile

Writes cn=<profile>,ou=localePolicies in this realm’s directory, REPLACING what is there; a realm with no default of its own follows the default realm’s, and named profiles are the realm’s own. defaultLocale (en) is a BCP 47 language tag: the language a page falls back to, and mail to a person who names none is written in. populatePreferredLanguage (on) gives a person created without a preferredLanguage that tag. A named profile carries a precedence (1 to 1000, 100 when left out) and lists nothing: an application names it in appLocalePolicy and a group in stsLocalePolicy, and of those naming one for a page the lowest precedence applies, else default. A named profile something names is not deleted (STS-I18N-0014).

Every field is required and one left out is refused by name rather than reset to a default, because a save that quietly loosened a rule nobody mentioned is the mistake nobody sees.

Mirrors POST /admin/policies on the admin console.

Scope: admin:write.

Parameters

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

Request body

Member Type Required What it is
defaultLocale string yes A BCP 47 language tag (RFC 5646), such as en, fr-CA or zh-TW. Pages are drawn in it when the request, the person’s preferredLanguage, the language chooser and the browser name nothing a catalog answers; dates and numbers are formatted for it even where no catalog does. Mail to a person whose entry names no language is written in it. Replaces the setting mail.defaultLanguage. Default en.
description string   What the profile is for, for the next person. Optional.
populatePreferredLanguage boolean, or string yes ON BY DEFAULT. A person entry created in this realm without a preferredLanguage (RFC 2798 section 2.7) is given the default language above as one — by the console, the management API, SCIM, a federated or self-service sign-up, or a bulk load. A named profile applies where the application that caused the creation names it, or one of the person’s groups does. Existing entries are never rewritten. (true/false, or TRUE/FALSE from a form.) Default true.
precedence integer, or string   A named profile only: the lowest matching precedence wins. Default 100.
profile string   Which profile: default, or a named profile (lower-case letters, digits and hyphens), which is created by its first save.

200: The profile now in force and the rules as sentences.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.defaultLocale list, or string, or number, or boolean, or null    
profile.defaultLocale[] string, or number, or boolean, or null    
profile.description string    
profile.dn string    
profile.enforced boolean    
profile.from string    
profile.inherited boolean    
profile.name string    
profile.populatePreferredLanguage list, or string, or number, or boolean, or null    
profile.populatePreferredLanguage[] string, or number, or boolean, or null    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
removed boolean    
rules list    
rules[] string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.defaultLocale list, or string, or number, or boolean, or null    
profile.defaultLocale[] string, or number, or boolean, or null    
profile.description string    
profile.dn string    
profile.enforced boolean    
profile.from string    
profile.inherited boolean    
profile.name string    
profile.populatePreferredLanguage list, or string, or number, or boolean, or null    
profile.populatePreferredLanguage[] string, or number, or boolean, or null    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
removed boolean    
rules list    
rules[] string    

POST /admin-api/policies/save-named-authn-policy

saveNamedAuthnPolicy

Create or replace a named authentication policy in this realm

Writes cn=<name>,ou=authnPolicies in this realm’s directory: the first-factor mechanisms (mechanisms) and the second factors (secondFactors) a sign-in allows where this policy applies — each list the WHOLE list, none allowing every one (and leaving the realm’s second factors as they are) — and its precedence (#1237). It applies where the application names it (appAuthnPolicy) or one of the person’s groups does (stsAuthnPolicy) and its precedence is the lowest of those named, ties by name. The realm’s own: not inherited from the default realm. The name is lower-case letters, digits and hyphens, not default (STS-AUTHN-0532); an unknown mechanism is refused (STS-AUTHN-0533), and a precedence that is not a whole number from 1 to 1000 (STS-AUTHN-0541).

Mirrors POST /admin/policies on the admin console.

Scope: admin:write.

Parameters

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

Request body

Member Type Required What it is
description string   What the policy is for.
mechanisms list   The first-factor mechanisms allowed: password, password-mfa, webauthn, spnego, wallet, federation.
mechanisms[] string    
name string yes The policy’s name.
precedence integer, or string   Where several named policies are named for one sign-in, the lowest applies; 100 when omitted.
secondFactors list   The second factors allowed: password, securityKey, totp, recoveryCode, emailCode, emailLink, wallet.
secondFactors[] string    

200: What was done, and the sentence saying so.

Member Type Required What it is
dn string    
errors list    
errors[] string    
kind string    
message string    
name string    
ok boolean yes  
policy object    
policy.description string    
policy.dn string    
policy.mechanisms list    
policy.mechanisms[] string    
policy.name string    
policy.precedence integer    
policy.secondFactors list    
policy.secondFactors[] string    
removed boolean    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
dn string    
errors list    
errors[] string    
kind string    
message string    
name string    
ok boolean yes  
policy object    
policy.description string    
policy.dn string    
policy.mechanisms list    
policy.mechanisms[] string    
policy.name string    
policy.precedence integer    
policy.secondFactors list    
policy.secondFactors[] string    
removed boolean    

POST /admin-api/policies/save-passkey-policy

savePasskeyPolicy

Set the passkey policy profile

Writes cn=default,ou=passkeyPolicies in this realm’s directory, REPLACING what is there; a realm with no entry of its own follows the default realm’s. allowUsernameless (on by default) offers a passkey sign-in with no username. requireUsernameless (off, #608) makes it the only way in for an application whose named authentication policy (appAuthnPolicy) lists webauthn alone as its first factor: no username field, and a sign-in naming a person refused; it needs allowUsernameless, and the default profile never applies it to the admin console, the debugger or the user portal. While it is off, “Use a security key” asks the authenticator for a discoverable credential (residentKey: required), as “Create a passkey” always does; while it is on, it asks securityKeyResidentKey (discouraged, preferred or required, default required). backupEligibility (allow by default) set to disallow refuses a synced (backup-eligible) passkey at registration and at sign-in. enforcePinLength (off) asks a key for its minimum PIN length (CTAP 2.1 minPinLength) and holds it to minPinLength (4 to 63); pinLengthOnlyIfSupported (off) accepts a key that does not report. enforceAttestationAtSignIn (off) holds every passkey sign-in to the attestation rules in force. passkeyHints, securityKeyHints and signInHints are the WebAuthn hints each ceremony sends, in order, or none. enterpriseSerialAttribute (empty) names the attribute of a person’s entry holding their security-key serials, which a registration’s trusted enterprise attestation must name. userDisplayName, rpNameExtras and credentialLabel are the names a passkey prompt and a new key show. aggregateDevices (on) offers a person’s passkeys as one sign-in choice; off, one per passkey. postQuantumRequired (off, #718) set to sign-in lets only a post-quantum (ML-DSA) passkey sign a person in, as the first credential or the second factor, and registration-and-sign-in refuses a classical one at registration too; refused while the realm offers no ML-DSA (STS-AUTHN-0357). attestationAlgorithms (none, #941, optional) lists the algorithms a passkey’s ATTESTATION must be signed with, statement and every certificate leaf to anchor: post-quantum, ml-dsa-44, ml-dsa-65, ml-dsa-87, slh-dsa, composite-ml-dsa; set, it demands a trusted statement and refuses any other at registration (STS-AUTHN-0411), and at sign-in while enforceAttestationAtSignIn is on (STS-AUTHN-0412). postQuantumAllowCredentials (realm, #946; optional) chooses how the passkey step names the keys while one is required: narrow the post-quantum ones only, list-and-refuse every one, a classical assertion then refused after the ceremony with a page saying why, and realm the realm’s webauthn.postQuantumAllowCredentials. registrationAlgorithms (realm, #940; optional) is the ordered list a registration offers this profile’s people in place of the realm’s webauthn.algorithms, and registrationMode (realm, #940; optional) is pq-only (ML-DSA only, no classical retry), pq-first (ML-DSA, then the classical algorithms, whatever the realm’s pqcOnly), classical-only (no ML-DSA, no post-quantum lane) or realm (webauthn.pqcOnly and webauthn.pqcAlongsideClassical); a passkey outside what the profile offers is refused at registration (STS-AUTHN-0432). clientRules (empty, #1112; optional) names the clients — <browser> on <system>, each a family or * with an optional major-version range, ; between rules — whose registrations offer the list less ML-DSA, where a classical passkey is allowed. Refused: classical-only with postQuantumRequired not off or with attestationAlgorithms set (STS-AUTHN-0430), and pq-only or pq-first where the list offered names no ML-DSA (STS-AUTHN-0431).

Every field is required and one left out is refused by name rather than reset to a default, because a save that quietly loosened a rule nobody mentioned is the mistake nobody sees.

Mirrors POST /admin/policies on the admin console.

Scope: admin:write.

Parameters

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

Request body

Member Type Required What it is
adminEnrolment one of off, on   off BY DEFAULT. on lets an administrator holding the Admin Write console role enrol a passkey for a person this profile applies to, from the person’s page on the console or /admin-api: the registration ceremony runs in the administrator’s own browser, against an authenticator they hold (a security key to be handed over, say), under the person’s user handle, and is verified exactly as the person’s own registration is — attestation, algorithms and this policy’s registration rules. Nothing made elsewhere can be imported. The key records which administrator enrolled it and when, and the person is told. Left out of a save, the built-in default is kept. Default off.
aggregateDevices boolean, or string yes ON BY DEFAULT: one “Use passkey” step whose request lists every one of the person’s passkeys, and the browser offers whichever is present. Off, a person with more than one is shown a choice per passkey, by its name, and the request names only that one. (true/false, or TRUE/FALSE from a form.) Default true.
allowUsernameless boolean, or string yes ON BY DEFAULT. On, the sign-in screen offers Sign in with a passkey and the username field’s autofill, which ask the browser for any discoverable credential of this realm (WebAuthn Level 3 section 5.4, allowCredentials empty) and sign in the account its user handle names, with user verification required and checked. Off, neither is offered and a sign-in always names the person first. Replaces the setting webauthn.usernameless. (true/false, or TRUE/FALSE from a form.) Default true.
attestationAlgorithms string   none BY DEFAULT: an attestation is accepted whatever it is signed with. Otherwise a list from post-quantum, ml-dsa-44, ml-dsa-65, ml-dsa-87, slh-dsa and composite-ml-dsa: a passkey registers only with a TRUSTED attestation that carries a certificate, whose statement signature and the signature on every certificate of its chain, from the leaf to the trust anchor, are each one the list allows (post-quantum allows any ML-DSA, SLH-DSA or composite ML-DSA signature). Self and none attestation are refused, having no certificate. With enforceAttestationAtSignIn on, every sign-in holds the passkey to it by what its registration recorded, so a passkey registered before the rule stops working. This is the attestation’s algorithm, not the passkey’s own (postQuantumRequired). Left out of a save, the built-in default is kept. An ordered, comma-separated list of post-quantum, ml-dsa-44, ml-dsa-65, ml-dsa-87, slh-dsa, composite-ml-dsa, or none. Default none.
backupEligibility one of allow, disallow yes allow (the default) accepts any passkey. disallow accepts only DEVICE-BOUND ones: a passkey whose authenticator says it may be backed up or synced (the BE flag, WebAuthn Level 3 section 6.1) is refused when it is registered and when it signs somebody in, so a synced passkey enrolled before the realm said no stops working too. BE never changes for a credential. Default allow.
clientRules string   EMPTY BY DEFAULT: every client is offered the list as it stands. Otherwise up to 20 rules separated by ;, each <browser> on <system>, where either side is a family as the passkey ceremony rows name it (Chrome, Firefox, macOS, Android) or * for any, optionally followed by a major-version range (141, 130-140, 130-, -140): Firefox 140- on Linux; * on Android 13. A passkey registration from a matching client offers the list less ML-DSA (ES256 and RS256 where that leaves none). Not applied where a classical passkey is not allowed — registrationMode pq-only, webauthn.pqcOnly, postQuantumRequired registration-and-sign-in, or at the sign-in step under postQuantumRequired sign-in — nor to the post-quantum lane, and the ceremony row says it was not. Left out of a save, empty is kept. Default empty.
credentialLabel string yes EMPTY BY DEFAULT: the provider’s name, else “Passkey” or “Security key”. Otherwise this text, with {provider} and {kind} filled in, at most 60 characters. The person may rename it afterwards, as always. Default empty.
description string   What the profile is for, for the next person. Optional.
deviceBoundRequired boolean, or string   OFF BY DEFAULT. On, an issuance to an application this profile covers waits until the sign-on session is bound to the browser’s key, and is refused when the browser skipped that registration or the wait elapsed without a binding. A session that was never offered registration is not refused by this row. Refused while authn.deviceBoundSessions is off. (true/false, or TRUE/FALSE from a form.) Default false.
enforceAttestationAtSignIn boolean, or string yes OFF BY DEFAULT. The attestation rules (the webauthn.attestation* settings: the policy, the AAGUID list, the certification level and FIPS) are checked when a passkey is registered. On, they are checked again at every sign-in against what was recorded then and the FIDO Metadata Service as it is now, so a key registered before a rule was tightened, or whose model was since reported compromised, stops signing anybody in. A key with no trusted attestation fails every rule that demands one. (true/false, or TRUE/FALSE from a form.) Default false.
enforcePinLength boolean, or string yes OFF BY DEFAULT. On, registration asks the authenticator for its minimum PIN length (CTAP 2.1 section 12.4, the minPinLength extension), records it on the key, and refuses a key whose minimum is below the next row, at registration and at every sign-in. A key answers only for relying parties it was configured to tell (CTAP 2.1 setMinPINLength with this RP ID); every other key, and every platform or synced passkey, does not report, and is refused unless the row after next is on. (true/false, or TRUE/FALSE from a form.) Default false.
enterpriseSerialAttribute string yes EMPTY BY DEFAULT: no serial is checked. Set to an attribute of a person’s entry (for example serialNumber, which may hold several values), a security key registers only with a TRUSTED enterprise attestation whose certificate names a device serial that is one of that person’s values. Needs webauthn.attestation set to enterprise, and the vendor or platform configured to release enterprise attestation to this RP ID; without that the browser sends ordinary attestation and every registration is refused. A directory attribute name, or empty for none. Default empty.
lanes one of realm, both, one   realm (the default) follows webauthn.pqcAlongsideClassical. both gives this profile’s people a classical and a post-quantum passkey side by side, each under its own user handle, wherever the realm’s setting is off; one gives them one lane wherever it is on. webauthn.pqcOnly still means one lane. Refused as both with registrationMode classical-only. Left out of a save, realm is kept. Default realm.
minPinLength integer, or string yes The shortest PIN a security key may be set to accept, as the key itself reports it, while the row above is on. Between 4 (CTAP 2.1’s own floor) and 63. Between 4 and 63. Default 4.
passkeyHints string yes The WebAuthn hints (Level 3 section 5.4.8) the portal’s Create a passkey sends, in order, from security-key, client-device and hybrid, or none. They tell the browser which way of making the passkey to lead with. A hint may not contradict webauthn.authenticatorAttachment: client-device implies platform, security-key and hybrid cross-platform. An ordered, comma-separated list of security-key, client-device, hybrid, or none. Default client-device,hybrid.
pinLengthOnlyIfSupported boolean, or string yes OFF BY DEFAULT, which is the strict reading: while the PIN length is enforced, a key that does not report it is refused. On, such a key is accepted and only a reported minimum is held to the rule — so the rule then binds only keys configured to report to this relying party. (true/false, or TRUE/FALSE from a form.) Default false.
postQuantumAllowCredentials one of realm, narrow, list-and-refuse   realm (the default) follows the realm’s webauthn.postQuantumAllowCredentials. Read only while postQuantumRequired requires a post-quantum passkey at sign-in. narrow names only the person’s post-quantum (ML-DSA) passkeys in the passkey step’s request, so a classical one is never offered, and a person whose device holds only their classical one sees the platform’s own “no passkey found” message. list-and-refuse names every passkey they hold and refuses a classical one after the ceremony, with a page saying that this application requires a post-quantum passkey and where to add one; the person may then pick a passkey that will be refused. A person holding no post-quantum passkey is told before any ceremony either way. Left out of a save, realm is kept. Default realm.
postQuantumRequired one of off, sign-in, registration-and-sign-in yes off (the default) accepts a passkey whatever its signature algorithm. sign-in accepts only a POST-QUANTUM passkey, one whose algorithm is ML-DSA-44, ML-DSA-65 or ML-DSA-87 (RFC 9964), when it signs somebody in, as the first credential or as the second factor; a classical one may still be registered. registration-and-sign-in refuses a classical one at registration too, and enrolment then offers only ML-DSA. The algorithm decides, not the lane a key was created in. Refused while the realm offers no ML-DSA (webauthn.algorithms names none, and neither webauthn.pqcOnly nor webauthn.pqcAlongsideClassical is on). Default off.
precedence integer, or string   A named profile only: the lowest matching precedence wins. Default 100.
profile string   Which profile: default, or a named profile (lower-case letters, digits and hyphens), which is created by its first save.
recoveryAssurance one of any, not-weaker, operator-only   any BY DEFAULT IN DEVELOPMENT, not-weaker IN PRODUCT. Whether a way back into the account that asks for no passkey — a password reset link, an activation link, a recovery code, an emailed code or link — restores access for a person who holds one. any: at once. not-weaker: the first sign-in after it that is not a passkey sign-in reaches no application; the person registers a passkey that satisfies this policy and signs in with it. operator-only: as not-weaker, and the self-service doors (the forgot-password form, a recovery code or an emailed code or link at sign-in) are refused; only an administrator’s reset link, generated password or activation link remains. Left out of a save, the built-in default is kept. Default any.
registrationAlgorithms string   realm (the default) offers the realm’s webauthn.algorithms. Otherwise the signature algorithms a passkey registration offers to this profile’s people, in order of preference (an authenticator makes the first it supports), from the algorithms webauthn.algorithms may name. The next row may narrow or reorder it, and a passkey whose algorithm is not one this profile offers is refused when it is registered. Left out of a save, realm is kept. An ordered, comma-separated list of ML-DSA-87, ML-DSA-65, ML-DSA-44, EdDSA, ES256, RS256, ESP256, Ed25519, ESP384, ES384, ESP512, ES512, Ed448, ES256K, PS256, PS384, PS512, RS384, RS512, or none. Default realm.
registrationMode one of realm, pq-only, pq-first, classical-only   realm (the default) follows webauthn.pqcOnly and webauthn.pqcAlongsideClassical. pq-only offers only ML-DSA, and refuses a retry with the classical algorithms. pq-first offers ML-DSA first and the classical algorithms after it, even where the realm requests ML-DSA only. classical-only offers no ML-DSA and no post-quantum passkey beside a classical one, for people whose devices fail an ML-DSA registration. Refused with postQuantumRequired other than off or with attestationAlgorithms set (classical-only), and where the algorithms offered name no ML-DSA (pq-only, pq-first). Left out of a save, realm is kept. Default realm.
requireUsernameless boolean, or string yes OFF BY DEFAULT. On, an application whose authentication mechanism is a passkey and nothing else (the authentication policy it names, appAuthnPolicy, lists webauthn alone) gets a sign-in screen with no username field: Sign in with a passkey is the way in, and a sign-in that names a person is refused. It needs the row above. The realm’s default profile does not apply it to the admin console, the debugger or the user portal; a named profile selecting that application does. (true/false, or TRUE/FALSE from a form.) Default false.
rpNameExtras one of none, realm, organisation, realm-and-organisation yes none (the default) shows webauthn.rpName alone. realm, organisation or realm-and-organisation append the realm’s name and/or saml.organizationName, so a person with accounts in several realms can tell the prompts apart. Default none.
securityKeyHints string yes The hints Use a security key sends, in order, or none. The button asks for a cross-platform authenticator, so client-device contradicts it and is refused. An ordered, comma-separated list of security-key, client-device, hybrid, or none. Default security-key.
securityKeyResidentKey one of discouraged, preferred, required yes The residentKey an enrolment through Use a security key (or one that names no kind) sends WHILE usernameless sign-in is ON. While it is off the button always asks required, so it makes a discoverable credential as Create a passkey does (which asks required always). discouraged or preferred spare a security key’s few resident slots, at the cost of a key that needs the username to sign in. Replaces the setting webauthn.residentKey. Default required.
signInHints string yes The hints a sign-in ceremony sends — the passkey step, the sign-in with no username and its autofill — in order, or none (the default: the browser offers every way it knows). An ordered, comma-separated list of security-key, client-device, hybrid, or none. Default none.
userDisplayName string yes EMPTY BY DEFAULT: the name the sign-in knows, else the username. Otherwise up to six directory attributes in order, separated by commas; a group of attributes separated by spaces (givenName sn) joins their values. The first whose every attribute has a value becomes user.displayName (WebAuthn Level 3 section 5.4.3), with control and direction-changing characters removed and at most 64 characters. The username is always user.name. Default empty.

200: The profile now in force and the rules as sentences.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.adminEnrolment list, or string, or number, or boolean, or null    
profile.adminEnrolment[] string, or number, or boolean, or null    
profile.aggregateDevices list, or string, or number, or boolean, or null    
profile.aggregateDevices[] string, or number, or boolean, or null    
profile.allowUsernameless list, or string, or number, or boolean, or null    
profile.allowUsernameless[] string, or number, or boolean, or null    
profile.attestationAlgorithms list, or string, or number, or boolean, or null    
profile.attestationAlgorithms[] string, or number, or boolean, or null    
profile.backupEligibility list, or string, or number, or boolean, or null    
profile.backupEligibility[] string, or number, or boolean, or null    
profile.clientRules list, or string, or number, or boolean, or null    
profile.clientRules[] string, or number, or boolean, or null    
profile.credentialLabel list, or string, or number, or boolean, or null    
profile.credentialLabel[] string, or number, or boolean, or null    
profile.description string    
profile.deviceBoundRequired list, or string, or number, or boolean, or null    
profile.deviceBoundRequired[] string, or number, or boolean, or null    
profile.dn string    
profile.enforceAttestationAtSignIn list, or string, or number, or boolean, or null    
profile.enforceAttestationAtSignIn[] string, or number, or boolean, or null    
profile.enforcePinLength list, or string, or number, or boolean, or null    
profile.enforcePinLength[] string, or number, or boolean, or null    
profile.enforced boolean    
profile.enterpriseSerialAttribute list, or string, or number, or boolean, or null    
profile.enterpriseSerialAttribute[] string, or number, or boolean, or null    
profile.from string    
profile.inherited boolean    
profile.lanes list, or string, or number, or boolean, or null    
profile.lanes[] string, or number, or boolean, or null    
profile.minPinLength list, or string, or number, or boolean, or null    
profile.minPinLength[] string, or number, or boolean, or null    
profile.name string    
profile.passkeyHints list, or string, or number, or boolean, or null    
profile.passkeyHints[] string, or number, or boolean, or null    
profile.pinLengthOnlyIfSupported list, or string, or number, or boolean, or null    
profile.pinLengthOnlyIfSupported[] string, or number, or boolean, or null    
profile.postQuantumAllowCredentials list, or string, or number, or boolean, or null    
profile.postQuantumAllowCredentials[] string, or number, or boolean, or null    
profile.postQuantumRequired list, or string, or number, or boolean, or null    
profile.postQuantumRequired[] string, or number, or boolean, or null    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.recoveryAssurance list, or string, or number, or boolean, or null    
profile.recoveryAssurance[] string, or number, or boolean, or null    
profile.registrationAlgorithms list, or string, or number, or boolean, or null    
profile.registrationAlgorithms[] string, or number, or boolean, or null    
profile.registrationMode list, or string, or number, or boolean, or null    
profile.registrationMode[] string, or number, or boolean, or null    
profile.requireUsernameless list, or string, or number, or boolean, or null    
profile.requireUsernameless[] string, or number, or boolean, or null    
profile.rpNameExtras list, or string, or number, or boolean, or null    
profile.rpNameExtras[] string, or number, or boolean, or null    
profile.securityKeyHints list, or string, or number, or boolean, or null    
profile.securityKeyHints[] string, or number, or boolean, or null    
profile.securityKeyResidentKey list, or string, or number, or boolean, or null    
profile.securityKeyResidentKey[] string, or number, or boolean, or null    
profile.signInHints list, or string, or number, or boolean, or null    
profile.signInHints[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
profile.userDisplayName list, or string, or number, or boolean, or null    
profile.userDisplayName[] string, or number, or boolean, or null    
removed boolean    
rules list    
rules[] string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.adminEnrolment list, or string, or number, or boolean, or null    
profile.adminEnrolment[] string, or number, or boolean, or null    
profile.aggregateDevices list, or string, or number, or boolean, or null    
profile.aggregateDevices[] string, or number, or boolean, or null    
profile.allowUsernameless list, or string, or number, or boolean, or null    
profile.allowUsernameless[] string, or number, or boolean, or null    
profile.attestationAlgorithms list, or string, or number, or boolean, or null    
profile.attestationAlgorithms[] string, or number, or boolean, or null    
profile.backupEligibility list, or string, or number, or boolean, or null    
profile.backupEligibility[] string, or number, or boolean, or null    
profile.clientRules list, or string, or number, or boolean, or null    
profile.clientRules[] string, or number, or boolean, or null    
profile.credentialLabel list, or string, or number, or boolean, or null    
profile.credentialLabel[] string, or number, or boolean, or null    
profile.description string    
profile.deviceBoundRequired list, or string, or number, or boolean, or null    
profile.deviceBoundRequired[] string, or number, or boolean, or null    
profile.dn string    
profile.enforceAttestationAtSignIn list, or string, or number, or boolean, or null    
profile.enforceAttestationAtSignIn[] string, or number, or boolean, or null    
profile.enforcePinLength list, or string, or number, or boolean, or null    
profile.enforcePinLength[] string, or number, or boolean, or null    
profile.enforced boolean    
profile.enterpriseSerialAttribute list, or string, or number, or boolean, or null    
profile.enterpriseSerialAttribute[] string, or number, or boolean, or null    
profile.from string    
profile.inherited boolean    
profile.lanes list, or string, or number, or boolean, or null    
profile.lanes[] string, or number, or boolean, or null    
profile.minPinLength list, or string, or number, or boolean, or null    
profile.minPinLength[] string, or number, or boolean, or null    
profile.name string    
profile.passkeyHints list, or string, or number, or boolean, or null    
profile.passkeyHints[] string, or number, or boolean, or null    
profile.pinLengthOnlyIfSupported list, or string, or number, or boolean, or null    
profile.pinLengthOnlyIfSupported[] string, or number, or boolean, or null    
profile.postQuantumAllowCredentials list, or string, or number, or boolean, or null    
profile.postQuantumAllowCredentials[] string, or number, or boolean, or null    
profile.postQuantumRequired list, or string, or number, or boolean, or null    
profile.postQuantumRequired[] string, or number, or boolean, or null    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.recoveryAssurance list, or string, or number, or boolean, or null    
profile.recoveryAssurance[] string, or number, or boolean, or null    
profile.registrationAlgorithms list, or string, or number, or boolean, or null    
profile.registrationAlgorithms[] string, or number, or boolean, or null    
profile.registrationMode list, or string, or number, or boolean, or null    
profile.registrationMode[] string, or number, or boolean, or null    
profile.requireUsernameless list, or string, or number, or boolean, or null    
profile.requireUsernameless[] string, or number, or boolean, or null    
profile.rpNameExtras list, or string, or number, or boolean, or null    
profile.rpNameExtras[] string, or number, or boolean, or null    
profile.securityKeyHints list, or string, or number, or boolean, or null    
profile.securityKeyHints[] string, or number, or boolean, or null    
profile.securityKeyResidentKey list, or string, or number, or boolean, or null    
profile.securityKeyResidentKey[] string, or number, or boolean, or null    
profile.signInHints list, or string, or number, or boolean, or null    
profile.signInHints[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
profile.userDisplayName list, or string, or number, or boolean, or null    
profile.userDisplayName[] string, or number, or boolean, or null    
removed boolean    
rules list    
rules[] string    

POST /admin-api/policies/save-password-policy

savePasswordPolicy

Set the password policy profile

Writes cn=<profile>,ou=passwordPolicies in this realm’s directory, REPLACING what is there: default, or a named policy, created by its first save (#1236). generatedLength must be at least minLength, and minSymbols, requireUppercase and requireDigit may only be 0 or false (ASVS 5.0.0 6.2.5). An application (appPasswordPolicy) and a group (stsPasswordPolicy) name a named policy; of those naming one for a person the lowest precedence applies (ties by name), else default, and a reference to a policy the realm does not hold names nothing, and the rest still rank (STS-AUTHN-0539). A named policy still named is not removed (STS-AUTHN-0540). A change applies to the NEXT password set in this realm and to nothing already stored, which is a hash and cannot be re-checked.

Every field is required and one left out is refused by name rather than reset to a default, because a save that quietly loosened a rule nobody mentioned is the mistake nobody sees.

Mirrors POST /admin/policies on the admin console.

Scope: admin:write.

Parameters

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

Request body

Member Type Required What it is
argon2Iterations integer, or string   How many passes argon2id makes over its memory (t). 2 is OWASP’s minimum at 19 MiB; each pass adds the same time again. Between 2 and 16. Default 2.
argon2Memory integer, or string   The memory one argon2id hash uses, in kibibytes (m). 19456 KiB (19 MiB) is OWASP’s minimum and the least this service will write. Raising it makes a stolen store slower to attack, and every sign-in uses that much more memory. Between 19456 and 1048576. Default 19456.
argon2Parallelism integer, or string   How many lanes argon2id divides its memory into (p). It is part of the hash, not a thread count: node computes a hash on one thread whatever this says. 1 is OWASP’s figure. Between 1 and 16. Default 1.
description string   What the profile is for, for the next person. Optional.
generatedLength integer, or string yes How long a password this service MAKES UP is — for a new user created from the console or /admin-api, an operator’s Generate, and the product-mode bootstrap account. It must be at least the minimum length and at least twice the symbol count plus two. Twenty characters from a 90-character alphabet is about 130 bits. Between 12 and 128. Default 20.
hashAlgorithm one of scrypt, argon2id   The algorithm a newly stored password is hashed with: scrypt (RFC 7914), the default, or argon2id (RFC 9106, the OWASP Password Storage Cheat Sheet’s first choice). A stored hash names its own algorithm and parameters and keeps verifying; one that is not in this algorithm with these parameters is hashed again at the person’s next verified sign-in. Client secrets, activation tokens, recovery codes and app passwords are not passwords and stay scrypt. Default scrypt.
history integer, or string yes How many of a person’s PREVIOUS passwords are remembered and refused. The current password is always refused as well while this is above 0, so 5 means a new password may be none of the last six. 0 turns the rule off. The draft’s attribute, with the draft’s meaning. Each remembered password is kept as the hash it was already stored as (argon2id or scrypt), in pwdHistory on the person’s own entry, and checking a new password costs one hash comparison per one remembered. Between 0 and 24. Default 5.
minLength integer, or string yes The shortest password this service will set, counted in characters (Unicode code points, so an emoji is one). The attribute is draft-behera-ldap-password-policy’s. Twelve is the default; NIST SP 800-63B asks for at least 8, and 15 where a password is the only factor. Between 1 and 1024. Default 12.
minSymbols integer, or string yes Always 0. A policy that asks for symbols is refused: ASVS 5.0.0 6.2.5 requires that a password of any composition be accepted, so length is what this policy asks for. Between 0 and 16. Default 0.
precedence integer, or string   A named profile only: the lowest matching precedence wins. Default 100.
profile string   Which profile: default, or a named profile (lower-case letters, digits and hyphens), which is created by its first save.
requireDigit boolean, or string yes Always off. A policy that requires a number is refused: ASVS 5.0.0 6.2.5 requires that a password of any composition be accepted. (true/false, or TRUE/FALSE from a form.) Default false.
requireUppercase boolean, or string yes Always off. A policy that requires an uppercase letter is refused: ASVS 5.0.0 6.2.5 requires that a password of any composition be accepted. (true/false, or TRUE/FALSE from a form.) Default false.
scryptBlockSize integer, or string   scrypt’s block size for a newly stored password while the algorithm is scrypt. Memory is about 128 × N × r bytes; 8 is the figure RFC 7914 and OWASP give. Between 8 and 16. Default 8.
scryptLogN integer, or string   scrypt’s CPU and memory cost for a newly stored password while the algorithm is scrypt, as a power of two: 15 (the default) is N=32768. OWASP’s table pairs it with the parallelism: 2^17 with p=1, 2^16 with p=2, 2^15 with p=3, 2^14 with p=5, or 2^13 with p=10. The default, 2^15 with p=1, is below it. Between 13 and 20. Default 15.
scryptParallelism integer, or string   scrypt’s parallelism for a newly stored password while the algorithm is scrypt. Node computes it on one thread, so a higher value costs time rather than cores; the cost’s description lists the pairs OWASP accepts. Between 1 and 16. Default 1.

200: The profile now in force and the rules as sentences.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.argon2Iterations list, or string, or number, or boolean, or null    
profile.argon2Iterations[] string, or number, or boolean, or null    
profile.argon2Memory list, or string, or number, or boolean, or null    
profile.argon2Memory[] string, or number, or boolean, or null    
profile.argon2Parallelism list, or string, or number, or boolean, or null    
profile.argon2Parallelism[] string, or number, or boolean, or null    
profile.description string    
profile.dn string    
profile.enforced boolean    
profile.from string    
profile.generatedLength list, or string, or number, or boolean, or null    
profile.generatedLength[] string, or number, or boolean, or null    
profile.hashAlgorithm list, or string, or number, or boolean, or null    
profile.hashAlgorithm[] string, or number, or boolean, or null    
profile.history list, or string, or number, or boolean, or null    
profile.history[] string, or number, or boolean, or null    
profile.inherited boolean    
profile.minLength list, or string, or number, or boolean, or null    
profile.minLength[] string, or number, or boolean, or null    
profile.minSymbols list, or string, or number, or boolean, or null    
profile.minSymbols[] string, or number, or boolean, or null    
profile.name string    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.requireDigit list, or string, or number, or boolean, or null    
profile.requireDigit[] string, or number, or boolean, or null    
profile.requireUppercase list, or string, or number, or boolean, or null    
profile.requireUppercase[] string, or number, or boolean, or null    
profile.scryptBlockSize list, or string, or number, or boolean, or null    
profile.scryptBlockSize[] string, or number, or boolean, or null    
profile.scryptLogN list, or string, or number, or boolean, or null    
profile.scryptLogN[] string, or number, or boolean, or null    
profile.scryptParallelism list, or string, or number, or boolean, or null    
profile.scryptParallelism[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
removed boolean    
rules list    
rules[] string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.argon2Iterations list, or string, or number, or boolean, or null    
profile.argon2Iterations[] string, or number, or boolean, or null    
profile.argon2Memory list, or string, or number, or boolean, or null    
profile.argon2Memory[] string, or number, or boolean, or null    
profile.argon2Parallelism list, or string, or number, or boolean, or null    
profile.argon2Parallelism[] string, or number, or boolean, or null    
profile.description string    
profile.dn string    
profile.enforced boolean    
profile.from string    
profile.generatedLength list, or string, or number, or boolean, or null    
profile.generatedLength[] string, or number, or boolean, or null    
profile.hashAlgorithm list, or string, or number, or boolean, or null    
profile.hashAlgorithm[] string, or number, or boolean, or null    
profile.history list, or string, or number, or boolean, or null    
profile.history[] string, or number, or boolean, or null    
profile.inherited boolean    
profile.minLength list, or string, or number, or boolean, or null    
profile.minLength[] string, or number, or boolean, or null    
profile.minSymbols list, or string, or number, or boolean, or null    
profile.minSymbols[] string, or number, or boolean, or null    
profile.name string    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.requireDigit list, or string, or number, or boolean, or null    
profile.requireDigit[] string, or number, or boolean, or null    
profile.requireUppercase list, or string, or number, or boolean, or null    
profile.requireUppercase[] string, or number, or boolean, or null    
profile.scryptBlockSize list, or string, or number, or boolean, or null    
profile.scryptBlockSize[] string, or number, or boolean, or null    
profile.scryptLogN list, or string, or number, or boolean, or null    
profile.scryptLogN[] string, or number, or boolean, or null    
profile.scryptParallelism list, or string, or number, or boolean, or null    
profile.scryptParallelism[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
removed boolean    
rules list    
rules[] string    

POST /admin-api/policies/save-postLogin-policy

savePostLoginPolicy

Set the post-login activity policy profile

Writes cn=<profile>,ou=postLoginPolicies in this realm’s directory, REPLACING what is there; a realm with no default of its own follows the default realm’s, and named profiles are the realm’s own. Off by default (enabled). On, a person the profile reaches who is due the activity is asked after signing in, before being sent back to the application: pqc-passkey-migration asks a person holding a classical passkey and no post-quantum one to register an ML-DSA passkey, and — per noPasskey — a person holding none to register one. A passkey has no role (#1135): noPasskeyRole is accepted and ignored. Skip puts it off snoozeDays; once graceDays (0 = never) have passed since the person’s first invitation Skip is refused (STS-AUTHN-0474) and the sign-in is held until it is done, and a door that cannot ask for it refuses the sign-in (STS-AUTHN-0473). A named profile carries a precedence and nothing else: a group names it in stsPostLoginPolicy (POST /admin-api/groups/set-policy) and an application in appPostLoginPolicy (POST /admin-api/applications/set). Of the profile the application signed in to names and those the person’s groups name the lowest precedence wins, so a named profile with enabled off excludes them; a started activity’s mail and the progress report know no application and select by the groups alone. A profile something names is not deleted (STS-AUTHN-0543). method (#1100) is how a classical passkey is migrated: upgrade (proved once, then replaced in place on its authenticator), alongside (an ML-DSA passkey beside it) or automatic (the lanes decide). attestation (#1102): post-quantum counts an ML-DSA passkey as migrated only where its recorded attestation is post-quantum too. noPasskeyFallback (#1103): classical offers a person with no passkey a classical retry where their device cannot make ML-DSA.

Every field is required and one left out is refused by name rather than reset to a default, because a save that quietly loosened a rule nobody mentioned is the mistake nobody sees.

Mirrors POST /admin/policies on the admin console.

Scope: admin:write.

Parameters

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

Request body

Member Type Required What it is
activity one of pqc-passkey-migration yes What is asked. pqc-passkey-migration: a person holding a passkey made with a classical algorithm is asked to register a post-quantum (ML-DSA) passkey. Whether the classical passkey is replaced in place or kept beside it is the method’s to say (below). Nobody is asked where the realm offers no ML-DSA algorithm at registration (the default webauthn.algorithms does). Default pqc-passkey-migration.
attestation one of any, post-quantum yes any: its key algorithm is ML-DSA. post-quantum: its key algorithm is ML-DSA AND its recorded attestation was signed with post-quantum algorithms throughout; a passkey with a classical attestation, or none recorded, does not count, and its holder is asked for one that does. Default any.
description string   What the profile is for, for the next person. Optional.
enabled boolean, or string yes OFF BY DEFAULT. On, every person this profile reaches who is due the activity below is asked to do it after signing in, before they are sent back to the application. A named profile with this off EXCLUDES whoever it is selected for: the members of the groups naming it, and a sign-in to an application naming it. (true/false, or TRUE/FALSE from a form.) Default false.
graceDays integer, or string yes Counted from the person’s FIRST invitation. When it has passed, Skip is gone and the sign-in is held — no session is started — until the activity is done. 0 is no deadline: it can always be skipped. Between 0 and 3650. Default 0.
method one of automatic, upgrade, alongside yes upgrade: the person uses their classical passkey once, then an ML-DSA passkey replaces it in place on the same authenticator — one passkey, nothing left behind. alongside: an ML-DSA passkey is added beside it, in the post-quantum lane where the realm offers two lanes, or on another authenticator where it offers one. automatic: alongside where the person’s passkey policy offers two lanes, upgrade where it offers one. Default automatic.
noPasskey one of leave, invite, require yes leave: not asked. invite: asked to register a post-quantum passkey, and may always skip it. require: asked, and may skip it only until the allotted time has passed. Default leave.
noPasskeyFallback one of none, classical yes none: ML-DSA only. classical: after an ML-DSA registration fails on the device, a retry with the classical algorithms is offered (where the passkey policy allows one) — a classical passkey is better than a password, and its holder is asked for the migration later like anyone else’s. Default none.
noPasskeyRole string   Ignored since #1135: a passkey has no role, so a person with none registers a passkey and nothing else is asked. Accepted so that an older body is not refused; not stored, not answered.
precedence integer, or string   A named profile only: the lowest matching precedence wins. Default 100.
profile string   Which profile: default, or a named profile (lower-case letters, digits and hyphens), which is created by its first save.
snoozeDays integer, or string yes How long Skip puts the activity off for that person. Between 1 and 90. Default 7.

200: The profile now in force and the rules as sentences.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.activity list, or string, or number, or boolean, or null    
profile.activity[] string, or number, or boolean, or null    
profile.attestation list, or string, or number, or boolean, or null    
profile.attestation[] string, or number, or boolean, or null    
profile.description string    
profile.dn string    
profile.enabled list, or string, or number, or boolean, or null    
profile.enabled[] string, or number, or boolean, or null    
profile.enforced boolean    
profile.from string    
profile.graceDays list, or string, or number, or boolean, or null    
profile.graceDays[] string, or number, or boolean, or null    
profile.inherited boolean    
profile.method list, or string, or number, or boolean, or null    
profile.method[] string, or number, or boolean, or null    
profile.name string    
profile.noPasskey list, or string, or number, or boolean, or null    
profile.noPasskey[] string, or number, or boolean, or null    
profile.noPasskeyFallback list, or string, or number, or boolean, or null    
profile.noPasskeyFallback[] string, or number, or boolean, or null    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.snoozeDays list, or string, or number, or boolean, or null    
profile.snoozeDays[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
removed boolean    
rules list    
rules[] string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.activity list, or string, or number, or boolean, or null    
profile.activity[] string, or number, or boolean, or null    
profile.attestation list, or string, or number, or boolean, or null    
profile.attestation[] string, or number, or boolean, or null    
profile.description string    
profile.dn string    
profile.enabled list, or string, or number, or boolean, or null    
profile.enabled[] string, or number, or boolean, or null    
profile.enforced boolean    
profile.from string    
profile.graceDays list, or string, or number, or boolean, or null    
profile.graceDays[] string, or number, or boolean, or null    
profile.inherited boolean    
profile.method list, or string, or number, or boolean, or null    
profile.method[] string, or number, or boolean, or null    
profile.name string    
profile.noPasskey list, or string, or number, or boolean, or null    
profile.noPasskey[] string, or number, or boolean, or null    
profile.noPasskeyFallback list, or string, or number, or boolean, or null    
profile.noPasskeyFallback[] string, or number, or boolean, or null    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.snoozeDays list, or string, or number, or boolean, or null    
profile.snoozeDays[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
removed boolean    
rules list    
rules[] string    

POST /admin-api/policies/save-serviceAccount-policy

saveServiceAccountPolicy

Set the service-account policy profile

Writes cn=default,ou=serviceAccountPolicies in this realm’s directory, REPLACING what is there; a realm with no entry of its own follows the default realm’s. Every default is the more secure one: no second-factor exemption, no browser sign-in, no rotation, an owner required. Two rules read other registers: generatedLength may not be below the password policy’s minLength, and rotationEnabled is refused while the realm has no push destination. The seven allow* door fields say which password doors a service account may use. A NAMED profile (#1240) — profile of lower-case letters, digits and hyphens, with precedence — is this realm’s own and governs every service account whose stsServiceAccountPolicy names it (set on the person’s Policies tab or by POST /admin-api/users/set-attribute; only a service account may hold it, STS-SVCACCT-0048). A reference the realm does not hold gets default and is logged (STS-SVCACCT-0047), and a named profile an account still names is not deleted (STS-SVCACCT-0049).

Every field is required and one left out is refused by name rather than reset to a default, because a save that quietly loosened a rule nobody mentioned is the mistake nobody sees.

Mirrors POST /admin/policies on the admin console.

Scope: admin:write.

Parameters

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

Request body

Member Type Required What it is
allowBrowserSignIn boolean, or string yes OFF BY DEFAULT. Off, the sign-in screen, the user portal and the admin console refuse a service account, whichever first factor it presents, and turning a person into a service account ends their browser sessions. A service account is used by a program, and a program has no business at a sign-in screen. (true/false, or TRUE/FALSE from a form.) Default false.
allowEst boolean, or string yes HTTP Basic at /.well-known/est (RFC 7030 section 3.2.3). Off, a service account’s right password is refused there as a wrong one is. (true/false, or TRUE/FALSE from a form.) Default true.
allowKerberos boolean, or string yes An AS-REQ whose pre-authentication proves the password’s key (RFC 4120), and MS-KKDCP. Off, a service account’s right password is refused there as a wrong one is. (true/false, or TRUE/FALSE from a form.) Default true.
allowLdapBind boolean, or string yes A bind on 389 or 636 (RFC 4513). Off, a service account’s right password is refused there as a wrong one is. (true/false, or TRUE/FALSE from a form.) Default true.
allowPasswordGrant boolean, or string yes grant_type=password at the token endpoint (RFC 6749 section 4.3), where the realm allows the grant at all. Off, a service account’s right password is refused there as a wrong one is. (true/false, or TRUE/FALSE from a form.) Default true.
allowScim boolean, or string yes HTTP Basic at /scim/v2 (RFC 7617). Off, a service account’s right password is refused there as a wrong one is. (true/false, or TRUE/FALSE from a form.) Default true.
allowSsf boolean, or string yes HTTP Basic at the /ssf endpoints (RFC 7617). Off, a service account’s right password is refused there as a wrong one is. (true/false, or TRUE/FALSE from a form.) Default true.
allowWsTrust boolean, or string yes A WS-Security UsernameToken sent to the security token service. Off, a service account’s right password is refused there as a wrong one is. (true/false, or TRUE/FALSE from a form.) Default true.
description string   What the profile is for, for the next person. Optional.
exemptFromSecondFactor boolean, or string yes OFF BY DEFAULT. On, the authentication policy’s second-factor requirements do not apply to a service account in this realm, and nor does the refusal of a password alone at the password doors (#101). The account’s amr still says pwd only, so a relying party asking for more is refused it. WEAKER: an account on a password alone is an account anyone with the password is. (true/false, or TRUE/FALSE from a form.) Default false.
generatedLength integer, or string yes Drawn by the password policy’s generator, so it meets that policy, and never shorter than its minimum length. Between 16 and 128. Default 32.
precedence integer, or string   A named profile only: the lowest matching precedence wins. Default 100.
profile string   Which profile: default, or a named profile (lower-case letters, digits and hyphens), which is created by its first save.
requireOwner boolean, or string yes ON BY DEFAULT. The owner — a person or a group in this realm — is who answers for the account; a service account cannot be saved without one while this is on. (true/false, or TRUE/FALSE from a form.) Default true.
rotationAlarmFailures integer, or string yes A failed rotation is retried at the job’s next run. After this many in a row the account is reported on Monitoring → Service accounts and logged as an alarm (STS-SVCACCT-0042). Between 1 and 100. Default 3.
rotationEnabled boolean, or string yes OFF BY DEFAULT. On, the service-accounts.rotate job gives every service account that names a push destination a new generated password each interval: pushed to the destination FIRST, its hash committed only after the push succeeds, the previous password kept for the overlap below. A failed push changes nothing. Cannot be turned on while this realm has no push destination. (true/false, or TRUE/FALSE from a form.) Default false.
rotationIntervalDays integer, or string yes How long a service account’s password is kept before the job replaces it, counted from the last rotation (or the account’s last password change). Between 1 and 3650. Default 30.
rotationOverlapMinutes integer, or string yes After a rotation the previous password is accepted for this long, so a consumer slow to read the new one is not refused — nor counted by risk scoring as guessing (#226). The previous Kerberos keys are kept as long. 0: the old password stops at once. Between 0 and 10080. Default 60.

200: The profile now in force and the rules as sentences.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.allowBrowserSignIn list, or string, or number, or boolean, or null    
profile.allowBrowserSignIn[] string, or number, or boolean, or null    
profile.allowEst list, or string, or number, or boolean, or null    
profile.allowEst[] string, or number, or boolean, or null    
profile.allowKerberos list, or string, or number, or boolean, or null    
profile.allowKerberos[] string, or number, or boolean, or null    
profile.allowLdapBind list, or string, or number, or boolean, or null    
profile.allowLdapBind[] string, or number, or boolean, or null    
profile.allowPasswordGrant list, or string, or number, or boolean, or null    
profile.allowPasswordGrant[] string, or number, or boolean, or null    
profile.allowScim list, or string, or number, or boolean, or null    
profile.allowScim[] string, or number, or boolean, or null    
profile.allowSsf list, or string, or number, or boolean, or null    
profile.allowSsf[] string, or number, or boolean, or null    
profile.allowWsTrust list, or string, or number, or boolean, or null    
profile.allowWsTrust[] string, or number, or boolean, or null    
profile.description string    
profile.dn string    
profile.enforced boolean    
profile.exemptFromSecondFactor list, or string, or number, or boolean, or null    
profile.exemptFromSecondFactor[] string, or number, or boolean, or null    
profile.from string    
profile.generatedLength list, or string, or number, or boolean, or null    
profile.generatedLength[] string, or number, or boolean, or null    
profile.inherited boolean    
profile.name string    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.requireOwner list, or string, or number, or boolean, or null    
profile.requireOwner[] string, or number, or boolean, or null    
profile.rotationAlarmFailures list, or string, or number, or boolean, or null    
profile.rotationAlarmFailures[] string, or number, or boolean, or null    
profile.rotationEnabled list, or string, or number, or boolean, or null    
profile.rotationEnabled[] string, or number, or boolean, or null    
profile.rotationIntervalDays list, or string, or number, or boolean, or null    
profile.rotationIntervalDays[] string, or number, or boolean, or null    
profile.rotationOverlapMinutes list, or string, or number, or boolean, or null    
profile.rotationOverlapMinutes[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
removed boolean    
rules list    
rules[] string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
enforced boolean    
errors list    
errors[] string    
kind string    
message string    
ok boolean yes  
profile object    
profile.allowBrowserSignIn list, or string, or number, or boolean, or null    
profile.allowBrowserSignIn[] string, or number, or boolean, or null    
profile.allowEst list, or string, or number, or boolean, or null    
profile.allowEst[] string, or number, or boolean, or null    
profile.allowKerberos list, or string, or number, or boolean, or null    
profile.allowKerberos[] string, or number, or boolean, or null    
profile.allowLdapBind list, or string, or number, or boolean, or null    
profile.allowLdapBind[] string, or number, or boolean, or null    
profile.allowPasswordGrant list, or string, or number, or boolean, or null    
profile.allowPasswordGrant[] string, or number, or boolean, or null    
profile.allowScim list, or string, or number, or boolean, or null    
profile.allowScim[] string, or number, or boolean, or null    
profile.allowSsf list, or string, or number, or boolean, or null    
profile.allowSsf[] string, or number, or boolean, or null    
profile.allowWsTrust list, or string, or number, or boolean, or null    
profile.allowWsTrust[] string, or number, or boolean, or null    
profile.description string    
profile.dn string    
profile.enforced boolean    
profile.exemptFromSecondFactor list, or string, or number, or boolean, or null    
profile.exemptFromSecondFactor[] string, or number, or boolean, or null    
profile.from string    
profile.generatedLength list, or string, or number, or boolean, or null    
profile.generatedLength[] string, or number, or boolean, or null    
profile.inherited boolean    
profile.name string    
profile.precedence integer    
profile.problems list    
profile.problems[] string    
profile.requireOwner list, or string, or number, or boolean, or null    
profile.requireOwner[] string, or number, or boolean, or null    
profile.rotationAlarmFailures list, or string, or number, or boolean, or null    
profile.rotationAlarmFailures[] string, or number, or boolean, or null    
profile.rotationEnabled list, or string, or number, or boolean, or null    
profile.rotationEnabled[] string, or number, or boolean, or null    
profile.rotationIntervalDays list, or string, or number, or boolean, or null    
profile.rotationIntervalDays[] string, or number, or boolean, or null    
profile.rotationOverlapMinutes list, or string, or number, or boolean, or null    
profile.rotationOverlapMinutes[] string, or number, or boolean, or null    
profile.sources map    
profile.sources.{key} string    
profile.stored boolean    
removed boolean    
rules list    
rules[] string    

POST /admin-api/policies/update-person-attribute

updatePersonAttribute

Change a custom attribute of this realm

Rewrites cn=<name>,ou=attributeDefinitions with the label, description and portal flags sent; what is not sent is kept. portalVisible shows a person their own values on the user portal’s Overview, and portalEditable lets them change those values there (POST /account-api/attributes); both are false by default. Editable implies visible: making it editable stores it visible, and hiding it alone stores it not editable. Refused for a name the realm does not define (STS-LDAP-0206) and for a field that is not valid (STS-LDAP-0207). The syntax and the cardinality are fixed: a syntax or multiValued other than the definition’s own is refused (STS-LDAP-0208), because the values people hold were checked against them.

Mirrors POST /admin/policies on the admin console.

Scope: admin:write.

Parameters

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

Request body

Member Type Required What it is
description string   What it is for; empty removes it. Kept when not sent.
label string   What the pages draw beside the name. Kept when not sent.
multiValued boolean, or string   Accepted only as the definition’s own cardinality; any other is refused.
name string yes The attribute’s name.
portalEditable boolean   Whether a person may change their own values on the user portal. Kept when not sent; true turns portalVisible on.
portalVisible boolean   Whether a person sees their own values on the user portal. Kept when not sent; false also turns portalEditable off unless that is sent true.
syntax string   Accepted only as the definition’s own syntax; any other is refused.

200: What was done, and the sentence saying so.

Member Type Required What it is
definition object    
definition.description string    
definition.dn string    
definition.label string    
definition.multi boolean    
definition.name string    
definition.portalEditable boolean    
definition.portalVisible boolean    
definition.syntax string    
dn string    
errors list    
errors[] string    
holders integer    
kind string    
message string    
name string    
ok boolean yes  
removed boolean    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
definition object    
definition.description string    
definition.dn string    
definition.label string    
definition.multi boolean    
definition.name string    
definition.portalEditable boolean    
definition.portalVisible boolean    
definition.syntax string    
dn string    
errors list    
errors[] string    
holders integer    
kind string    
message string    
name string    
ok boolean yes  
removed boolean