AssignmentAuthenticator
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
Authenticate users with username and PhenixID One Touch.
Properties
| Name | Description | Default value | Mandatory |
|---|---|---|---|
| successURL | The URL to redirect the browser to, after successful authentication. |
Yes | |
| form_template_name | Login form template (html). | assignments.template |
|
| form_template_translation_keys | Comma separated list of translation keys to include in login form template rendering. |
||
| form_template_session_keys | Comma separated list of session keys to include in login form template rendering. |
||
| poll_interval | Number of milliseconds to wait between each poll for confirmed/rejected assignment |
2000 | |
| max_polls | Max number of polls for confirmed/rejected assignment to perform before timing out. |
30 | |
| max_wait | Max number of milliseconds for confirmed/rejected assignment to wait before timing out. If not specified; defaults to poll_interval x max_polls |
||
| poll_template_name |
Assignment poll template (html). This view is displayed while authenticator is waiting for the user to confirm or reject the assignment. |
onetouchpoll.template |
|
| poll_template_translation_keys |
Comma separated list of translation keys to include in assignment poll template rendering. |
||
| poll_template_session_keys |
Comma separated list of session keys to include in assignment poll template rendering. |
||
| notify | Flag controlling if user should be notified using push notification when there are pending assignments. | true |
|
| ot_push_title |
Notification title (alt name: ot_title) |
||
| ot_push_message |
Notification message (alt name: ot_message) |
||
| assignment_template_name |
Template for the assignment sent to the One Touch app and displayed to the user for confirm or reject. | ot_auth_template |
|
| assignment_template_translation_keys |
Comma separated list of translation keys to include in assignment template rendering (alt name: customTranslation) | ||
| assignment_template_session_keys |
Comma separated list of session keys to include in assignment template rendering. |
||
| assignment_template_service_name |
Display name of the assignment issuer (alt name: servicename) | PhenixID |
|
| enableHoneypot |
Enable login form honeypot, to prevent automated logins |
true |
|
| includeQueryString |
Enable to append query string (passed to authenticator) to successURL |
false |
|
| allowLanguageChange |
Flag enabling the the change language menu in login form. | ||
| quick_mode_enabled | Enables quick mode for this authenticator. |
false | No |
| quick_mode_category | Specify the category for the quick mode buttons. These categories can be used: category_yes_no, category_ok_cancel or category_confirm_reject. |
category_ok_cancel |
No |
Example Configuration
{
"id" : "ot_01",
"alias" : "ot",
"name" : "AssignmentAuthenticator",
"displayName" : "PhenixID One Touch",
"configuration" : {
"successURL" : "/application/",
"enableHoneypot" : "false",
"allowLanguageChange" : "true",
"notify" : "true",
"servicename" : "PhenixID Demo MyApps",
"ot_push_title" : "Pending assignment(s)",
"ot_push_message" : "Open One Touch to view your assignment(s)",
}
}
Requirements
- One Touch backend configured.
- One Touch activated by the authenticating user.