Token Authentication

Configuration reference for validating a user's OATH one-time password in Pipes.

The Token Authentication valve validates a one-time password against the OATH tokens assigned to a user. It writes the string value "true" or "false" to the current item's token_authenticated property.

Prerequisites

Deploy an OathValidation module in the same namespace before using this valve.

Configuration

Properties
Example

Name	Description	Default
`otp_length`	Number of trailing characters treated as the OTP when YubiKey support is enabled.	`6`
`otp_parameter`	Expression that resolves to the one-time password.	`""`
`username_parameter`	Expression that resolves to the user identifier.	`""`
`accept_legacy_token_check`	Continues the flow after failed validation and writes `token_authenticated` as `"false"`.	`false`
`accept_automatic_token_enrollment`	Continues the flow after failed validation so a later step can enroll a token, and writes `token_authenticated` as `"false"`.	`false`
`enable_yubikey`	Uses only the final `otp_length` characters when a YubiKey value contains a longer public ID prefix.	`false`
`namespace`	Namespace of the OATH validation module.	Value of `token_db_module_name`
`token_db_module_name`	Legacy namespace property. Prefer `namespace`.	`""`

{
    "name": "TokenAuthentication",
    "config": {
        "otp_length": 6,
        "otp_parameter": "${request.password}",
        "username_parameter": "${request.identifier}",
        "namespace": "default"
    }
}