Webauthn (Section)#

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

The settings for a WebAuthN authentication provider

Parameters#

NameTypeRequiredDefaultDescription
allow-registration-during-loginbooleanoptionaltrueWhether or not users should be able to register a device during the login process
ask-to-register-additional-platform-devicebooleanoptionaltrueIf enabled, when a user authenticates with a security key and has no built-in device registered for the active browser, they will immediately be asked to register an additional built-in device.
platform-device-cookie-namenon-empty-stringoptionalwebauthn-platform-deviceThe name of the cookie that keeps track of whether a built-in device has been registered for a particular browser.
require-user-to-set-aliasbooleanoptionalfalseRequire the users to set a device alias. This can be useful for users later to help them identify their devices.
user-display-name-attributenon-empty-stringoptionalsubjectThe user authentication subject attribute to use as the display name for the user in the WebAuthN authenticator. If not set, the default is username

Subsections#

NameTypeDescription
account-manager SectionNone
mode OneOfNone

Was this helpful?