Passkeys (Section)#

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

The settings for a Passkeys authentication provider

Parameters#

NameTypeRequiredDefaultDescription
allow-registration-during-loginbooleanoptionaltrueWhether or not users should be able to register a device during the login process
enable-discoverable-credentialsbooleanoptionalfalseEnable public key credential selection based on credentials known to the browser/operating system. Before enabling, please ensure your database structure has been updated as per the product’s upgrade guides.
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 Passkeys authenticator. If not set, the default is username

Subsections#

NameTypeDescription
account-manager SectionNone

Was this helpful?