Authenticator (List)#

Path: /profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator

Parameters#

NameTypeRequiredDefaultDescription
idstringrequired
authentication-context-class-referencestringoptionalThe Authentication Context Class Reference (ACR) that this authenticator supports
account-domainleafrefoptionalOptional domain in which accounts are stored
descriptionstringoptionalA readable description of the Authenticator, for User presentation, can be a locale key
sso-expiration-timeuint32optionalThis controls the expiration time for this specific authenticator. If this is not set, the value set on the profile will be used instead.A common scenario is to allow some factors to have longer lifetimes than others, which is accomplished by setting this value on the authenticator in question
sso-inactivity-timeoutuint32optionalThe maximum time an SSO session created by this authenticator will be valid without being used. If this value is not set, then the profile value will be used (if set there).
previous-authenticatorleafrefoptionalOptional authenticator (or any from a group) that the user must authenticate with prior to this one
purposeunionoptionalA category of usage that this authenticator instance is intended for.
exclude-from-metadatabooleanoptionalfalseWhether or not the authenticator should be excluded from the OAuth and OpenID Connect metadata (“acr_values_supported” attribute) of a token profile linked to this authentication profile
template-areanon-empty-stringoptional
cross-site-block-enabledbooleanoptionalEnables the unsafe (e.g. POST) cross-site requests blocking mechanism. Blocks cross-site requests (those originating from a different or third-party domain) with an unsafe method from being accepted, except for endpoints the explicitly allow it. Disabling this feature can help with interoperability but does pose security risks, and should only be enabled if strictly required.

Subsections#

NameTypeDescription
geo-filtering SectionNone
authentication-actions SectionNone
additional-context-attributes SectionList of key/value attributes that will be added to the context attributes when this authenticator finishes.
registration-requirement OneOfNone
request-validations SectionNone
authenticator-type OneOfNone

Was this helpful?