Authentication mechanisms
These files support the authentication mechanisms.
Authentication mechanisms
These files support the authentication mechanisms. For more information, see Authentication.
| Page name | File name and macros | Description and link to file contents |
|---|---|---|
| Change PIN required | otp/change_pin.html
Macros
|
Enables the user to enter a new PIN. |
| OTP Email Delivery Message | otp/delivery/email_message.xml | Used by EmailOTPDelivery as the content of the email that it sends to the user.
The template file must be a compliant XML file. The content can be plain text or HTML. Following is an example that uses HTML in the email template:
For more information about HTML formatting of email messages, see HTML format for OTP email messages. |
| OTP SMS Delivery Message | otp/delivery/sms_message.xml | Used by SMSOTPDelivery as the content of the SMS that it sends to the user.
The template file must be a compliant XML file. |
| One-Time Password Delivery Selection | otp/delivery_selection.html
Macros
|
Displays the list of methods for generating, delivering, and verifying the one-time password. |
| OTP General Error | otp/errors/allerror.html
Macros
|
Displays general errors that happen during the one-time password flow. |
| OTP Validation Error | otp/errors/error_could_not_validate_otp.html
Macros
|
Displays errors during the validation of the one-time password that the user submits. |
| OTP Generation Error | otp/errors/error_generating_otp.html
Macros
|
Displays errors during the generation of a one-time password. |
| OTP Methods Retrieval Error | otp/errors/error_get_delivery_options.html
Macros
|
Displays errors during the retrieval of the list of methods for delivering one-time password to the user. |
| OTP Delivery Error | otp/errors/error_otp_delivery.html
Macros
|
Displays errors during the delivery of a one-time password to the user. |
| OTP STS Invocation Error | otp/errors/error_sts_invoke_failed.html
Macros
|
Displays errors during the invocation of the Security Token Service. |
| One-Time Password Login | otp/login.html
Macros
|
Displays the form where the user can enter the one-time password. |
| Enter Next OTP Form | otp/next_otp.html
Macros
|
Enables the user to enter the next one time password. |
| Page name | File name and macros | Description |
|---|---|---|
| Authenticator Error Page | authsvc/authenticator/error.html
Macros
|
A generic authenticator error page. |
| Authenticator Login Page | authsvc/authenticator/login.html
Macros
|
A generic authenticator username and password login page. |
| Page name | File name and macros | Description |
|---|---|---|
| Change Password | authsvc/authenticator/basicldapuser/change_password.html
Macros
|
Enables the user to change their LDAP password. |
| Username and Password Login | authsvc/authenticator/bascildapuser/login.html
Macros
|
Displays the form where the user can enter their username and password to log in. |
| Page name | File name and macros | Description |
|---|---|---|
| Generic Decision | authsvc/authenticator/branching/generic_decision.html
Macros
|
Displays a form that allows the user to select an authentication branch to use from a list of available branches. |
| Second Factor Decision | authsvc/authenticator/branching/second_factor_decision.html
|
Displays a form that allows the user to select a second factor authentication method to use from a list of available methods. |
| Identifier First Authentication Page | authsvc/authenticator/branching/identifier_first.html
Macros:
|
Displays a form that allows the user to submit their username or perform autofill FIDO authentication. |
| IFA Authentication Method Choice Page | authsvc/authenticator/branching/ifa_choice.html
|
If enrolled, the user is prompted to choose between FIDO2/WebAuthn authentication, MMFA authentication, or standard username/password authentication. |
| IFA FIDO2 PAIR Registration Page | authsvc/authenticator/branching/ifa_fido2pair_reg.html
Macros:
|
Displays a page that allows a user to register a FIDO2 device for authentication. |
| IFA Redirect Page | authsvc/authenticator/branching/ifa_redirect.html
|
Redirects the user to the configured Redirect URL, if the username matched a set regular expression. |
| Page name | File name and macros | Description |
|---|---|---|
| Username and Password Login | authsvc/authenticator/ci/login.html
Macros
|
Displays the form where the user can enter their username and password to log in. |
| Authenticate Page | authsvc/authenticator/ci/authenticate_dialog.html
Macros
|
Displays a form that allows the user to select a method to use for two-step verification. |
| Choose Method Page | authsvc/authenticator/ci/choose_method.html
Macros
|
Displays a form that allows the user to select a method to use for two-step verification. |
| Verify Page | authsvc/authenticator/ci/verify.html
Macros
|
Displays a form that allows the user to enter the access code that is used to authenticate the two-step verification. |
| Device Connected Page | authsvc/authenticator/ci/device_connected.html
Macros
|
Displays a confirmation page that a device was successfully connected and can now be selected as a method for two-step verification. |
| Enrollment Page | authsvc/authenticator/ci/enrollment.html
Macros
|
Displays a form that is used to validate an OTP during an enrollment flow. |
| Error Page | authsvc/authenticator/ci/error.html
Macros
|
Displays errors during the CI authentication. |
| JIT Enroll Page | authsvc/authenticator/ci/jit_enroll.html
Macros
|
Displays a form that allows a user with no existing device registrations to enroll a device during a CI authentication. |
| TOTP Enrollment Page | authsvc/authenticator/ci/totp_enrollment.html
Macros
|
Displays a page that allows a user to enroll a device for TOTP authentication. |
| Push Notification Page | authsvc/authenticator/ci/try_push.html
Macros
|
Displays a page that allows a device to be configured and tested to receive push notifications to authenticate the two-step verification. |
| User Self-Care Page | authsvc/authenticator/ci/usc.html
Macros
|
Displays a page that allows a user to manage their registered authentication devices. |
| Username Login Page | authsvc/authenticator/ci/username.html
Macros
|
Displays the form where the user can enter their username to log in without a password. |
| Verify Registration Page | authsvc/authenticator/ci/verify_registration.html
Macros
|
Displays a page that allows a user to enroll a device to use IBM Verify for authentication. |
| Wait Page | authsvc/authenticator/ci/wait.html
Macros
|
Displays a page while it waits between polls during an IBM Verify authentication. |
| Page name | File name and macros | Description |
|---|---|---|
| Email Delivery Message | authsvc/authenticator/email_message/email_message.xml
Macros
|
The email content that is sent to the SMTP server. |
| Error Page | authsvc/authenticator/email_message/error.html
Macros
|
The email content that is sent to the SMTP server. |
| Page name | File name and macros | Description |
|---|---|---|
| Assertion Page | authsvc/authenticator/fido/assertion.html
Macros
|
Displays a form that allows a user to perform a FIDO authentication. |
| Attestation Page | authsvc/authenticator/fido/attestation.html
Macros
|
Displays a form that allows a user to register a FIDO device for authentication. |
| Error Page | authsvc/authenticator/fido/error.html
Macros
|
Displays errors during the FIDO authentication. |
| Page name | File name and macros | Description |
|---|---|---|
| FIDO2 PAIR Authentication Decision Page | authsvc/authenticator/fido2pair/fido2pair_authn_decision.html
Macros
|
Displays a page that allows a user to either login by using a username and password or by using an already registered FIDO device. |
| FIDO2 PAIR Login Success Page | authsvc/authenticator/fido2pair/fido2pair_login_success.html | Displays a page that indicates that the login was successful. The page is imported into the reverse proxy management root when FIDO2 PAIR is configured and the administrator chooses to overwrite the default login success page. It saves the persistent token from the reverse proxy into the browser for subsequent FIDO2 authentication. |
| FIDO2 PAIR Device Registration Complete Page | authsvc/authenticator/fido2pair/fido2pair_reg_complete.html
Macros
|
Displays a page that indicates that a FIDO2 device was registered successfully and can now be used for subsequent authentications. |
| FIDO2 PAIR Device Registration Decision Page | authsvc/authenticator/fido2pair/fido2pair_reg_decision.html
Macros
|
Displays a page that allows a user to decide whether they would like to register a FIDO2 device for authentication after the initial username and password login. |
| FIDO2 PAIR Device Registration Page | authsvc/authenticator/fido2pair/fido2pair_reg_mechanism.html
Macros
|
Displays a page that allows a user to register a FIDO2 device for authentication. |
| Page name | File name and macros | Description |
|---|---|---|
| Error Page | authsvc/authenticator/infomap/error.html
Macros
|
Displays a page that shows the details of an error that was encountered. |
| FIDO Assertion Page | authsvc/authenticator/infomap/fido_assertion.html
Macros
|
Displays a form that allows a user to perform a FIDO authentication. |
| FIDO Attestation Page | authsvc/authenticator/infomap/fido_attestation.html
Macros
|
Displays a form that allows a user to register a FIDO device for authentication. |
| Username Login Page | authsvc/authenticator/infomap/login.html
Macros
|
Displays the form where the user can enter their username to log in. |
| Page name | File name and macros | Description |
|---|---|---|
| Mobile Multi-Factor Authentication Device Selection Page | authsvc/authenticator/mfa/device_selection.html
Macros
|
Displays a form that allows a user to select which registered device to send a mobile multi factor authentication notification. |
| Mobile Multi-Factor Authentication Error Page | authsvc/authenticator/mmfa/error.html
Macros
|
Displays a page that shows the details of an error that was encountered. |
| Mobile Multi-Factor Authentication Login Wait Page | authsvc/authenticator/mmfa/login_wait.html
|
Displays a page that shows that a notification was sent to the selected device and waits for a response. |
| Page name | File name and macros | Description |
|---|---|---|
| Mobile User Approval Challenge Page | authsvc/authenticator/mobileuserapproval/challenge.html
Macros
|
Displays a form that allows a user to sign the challenge data with the key that is associated with a given key handle. |
| Mobile User Approval Error Page | authsvc/authenticator/mobileuserapproval/error.html
Macros
|
Displays a page that shows the details of an error that was encountered. |
| Page name | File name and macros | Description |
|---|---|---|
| QR Login Error Page | authsvc/authenticator/qrlogin/error.html
Macros
|
Displays errors during the QR code authentication. |
| QR Login Page | authsvc/authenticator/qrlogin/qrlogin.html
Macros
|
Displays a page that allows a user to authenticate by scanning a QR code with a registered device. |
| QR Login Response Page | authsvc/authenticator/qrlogin/qrresponse.html
Macros
|
Sends a response to the device to indicate that the QR code authentication was successful. |
| Page name | File name and macros | Description |
|---|---|---|
| ReCAPTCHA Challenge Page | authsvc/authenticator/recaptcha/standalone.html
Macros
|
Displays a form that prompts a user to fulfill a specific re-CAPTCHA challenge. |
| Page name | File name and macros | Description |
|---|---|---|
| RSA SecurID One-Time Password Error | authsvc/authenticator/rsa_securid/error.html
Macros
|
Displays errors during the RSA SecurID one-time password authentication. |
| RSA SecurID One-Time Password Login | authsvc/authenticator/rsa_securid/code.html
Macros
|
Displays a form where the user can enter the RSA SecurID one-time password to log in. |
| RSA SecurID One-Time Password Login (New PIN) | authsvc/authenticator/rsa_securid/new_pin.html
Macros
|
Enables a user to enter a new RSA SecurID pin. |
| RSA SecurID One-Time Password Login (Next OTP) | authsvc/authenticator/rsa_securid/next_code.html
Macros
|
Enables a user to enter the next RSA SecurID one-time password. |
| Page name | File name and macros | Description |
|---|---|---|
| U2F Token Error Page | authsvc/authenticator/u2f/error.html
Macros
|
Displays errors during the U2F token authentication. |
| U2F Token Registration Page | authsvc/authenticator/u2f/register.html
Macros
|
Displays a form to allow a user to register a U2F token for authentication. |
| Page name | File name and macros | Description |
|---|---|---|
| IBM Verify Gateway Response Page | authsvc/authenticator/verify_gateway/response.html | This file is not currently used. |
| Page name | File name and macros | Description |
|---|---|---|
| Change Password | authsvc/authenticator/password/change_password.html
Macros
|
Enables the users to change their registry password. |
| Username and Password Error | authsvc/authenticator/password/error.html
Macros
|
Displays errors during the username and password authentication or when the users modify their password. |
| Username and Password Login | authsvc/authenticator/password/login.html
Macros
|
Displays the form where the users can enter their username and password to log in. |
| Page name | File name and macros | Description |
|---|---|---|
| HTTP Redirect Authentication Error | authsvc/authenticator/http_redirect/allerror.html
Macros
|
Displays general errors during for HTTP redirect authentication mechanism. |
| HTTP Redirect Authentication Failed | authsvc/authenticator/http_redirect/error_authenticate.html
Macros
|
Displays errors during the HTTP redirect authentication flow. |
| Page name | File name and macros | Description |
|---|---|---|
| MAC One-Time Password Delivery Selection | authsvc/authenticator/macotp/delivery_selection.html
Macros
|
Displays the list of methods for generating, delivering, and verifying the one-time password. |
| MAC OTP One-Time Password Error | authsvc/authenticator/macotp/error.html
Macros
|
Displays errors during the MAC one-time password authentication. |
| MAC One-Time Password Login | authsvc/authenticator/macotp/login.html
Macros
|
Displays the form where the user can enter the MAC one-time password. |
| Page name | File name and macros | Description |
|---|---|---|
| RSA One-Time Password Error | authsvc/authenticator/rsa/error.html
Macros
|
Displays errors during the RSA one-time password authentication. |
| RSA One-Time Password Login | authsvc/authenticator/rsa/code.html
Macros
|
Displays the form where the users can enter the RSA one-time password to log in. |
| RSA One-Time Password Login (New PIN) | authsvc/authenticator/rsa/new_pin.html
Macros
|
Enables users to enter a new RSA pin. |
| RSA One-Time Password Login (Next OTP) | authsvc/authenticator/rsa/next_code.html
Macros
|
Enables users to enter the next RSA one-time password. |
| Page name | File name and macros | Description |
|---|---|---|
| TOTP One-Time Password Error | authsvc/authenticator/totp/error.html
Macros
|
Displays errors during the TOTP one-time password authentication. |
| TOTP One-Time Password Login | authsvc/authenticator/totp/login.html
Macros
|
Displays the form where the users can enter the TOTP password to log in. |
| Page name | File name and macros | Description |
|---|---|---|
| HOTP One-Time Password Error | authsvc/authenticator/hotp/error.html
Macros
|
Displays errors during the HOTP one-time password authentication. |
| HOTP One-Time Password Login | authsvc/authenticator/hotp/login.html
Macros
|
Displays the form where the users can enter the HOTP password to log in. |
| Page name | File name and macros | Description |
|---|---|---|
| Consent page | authsvc/authenticator/consent_register_device/consent-form.html
Macros
|
Prompts the user to provide consent for registering a device. |
| Consent to Device Registration Error | authsvc/authenticator/consent_register_device/error.html
Macros
|
Displays errors during the consent to device registration flow. |
| Page name | File name and macros | Description |
|---|---|---|
| End-User License Agreement license file display | authsvc/authenticator/eula/license.txt | Contains the license agreement to display to the user.
The template does not use replacement macros.
Note: You can add more license files to the template tree.
Specify the metadata in the End-User License Agreement for the following purposes:
When the user accepts the license agreement or declines the license agreement, the mechanism audits:
|
| End-User License Agreement license agreement display | authsvc/authenticator/eula/eula.html
Macros
|
Displays the page where the user views the license and accepts the license agreement. |
| End-User License Agreement license agreement decline | authsvc/authenticator/eula/error_license_declined.html
Macros
|
Displays the page where the user declines the license agreement. |
| Page name | File name and macros | Description |
|---|---|---|
| Knowledge Questions authentication mechanism knowledge login form | authsvc/authenticator/knowledge_questions/login.html
Macros
|
Displays the form where the user enters the answers to the required knowledge questions. |
| Knowledge Questions authentication mechanism knowledge question authentication errors | authsvc/authenticator/knowledge_questions/error.html
Macros
|
Displays errors during knowledge-question authentication. |
| Knowledge Questions authentication mechanism missing knowledge questions with grace period | authsvc/authenticator/knowledge_questions/ not_enough_questions_found_continue.html
Macros
|
Displayed when the user did not register the required number of knowledge questions and answers that are required for successful authentication. The following conditions must also be true:
|
| Knowledge Questions authentication mechanism missing knowledge questions without grace period | authsvc/authenticator/knowledge_questions/ not_enough_questions_found_error.html
Macros
|
Displayed when the user did not register the required number of knowledge questions and answers that are required for successful authentication. One of the following conditions must also be true:
|
| Page name | File name and macros | Description |
|---|---|---|
| OTP Enrollment main page | authsvc/authenticator/otp/enroll.html
Macros
|
Prompts a user to enroll TOTP or HOTP by displaying a QR code for the user to scan, or a manual code for them to type into their OTP application. |
| OTP Enrollment errors | authsvc/authenticator/otp/error.html
Macros
|
Displays errors during OTP enrollment. |