Table of Contents

Fido2Authenticator

Warning

This authenticator is a legacy authenticator. It is recommended to plan for migrating the authenticator to the new protocol agnostic authenticator architecture. More information about the legacy authenticators can be found here.

Note

Authenticating using FIDO2 tokens. Successful authentication redirects the user to configured destination and marks the session "authenticated".

Properties

Name Description Default value Mandatory
successURL The URL to redirect the browser to after successful authentication. Yes
loginTemplate Template to use for user interface. fido2.template No
includeQueryString Enable to append query string (passed to authenticator) to successURL. false No
userNameParamName Name of the username request attribute. username No
pipeID Id of the pipe to execute after successful token validation. The pipe must return a single item. N/A Yes
allowLanguageChange Enable or disable language change. Set true to allow language change. No

Example Configuration

{
    "alias" : "fidoAuth",
    "name" : "Fido2Authenticator",
    "configuration" : {
      "successURL" : "/config/",
      "pipeID" : "uservalidationpipe"
    },
    "id" : "fidoAuth"
}

Languagekeys

Authenticator knows the following localisation keys:

  • login.messages.username
  • login.messages.signin

Requirements

At least one FIDO token enrolled to the user authenticating.