Magic Link IdP Adapter settings reference
Field descriptions for the Magic Link IdP Adapter configuration screen.
Standard fields
Field | Description | ||
---|---|---|---|
Notification Publisher |
Select the notification publisher that sends the one-time link to the user. |
||
Link Expiration |
Define the duration, in minutes, that the magic link remains valid. |
||
Attribute Source |
The source of the preferred delivery method and contact attributes. Select a data store, or:
|
||
Email Attribute Name |
The attribute that the notification publisher uses to email the user. For example, This attribute can be from a data store or from earlier in the authentication flow.
|
||
Search String |
The string that the adapter uses to search the data store to find the user.
The
|
||
Base DN |
The base DN that the adapter uses when connecting to an LDAP data store.
|
||
Notification Publisher Failure Mode |
Determines whether the user authentication flow continues or fails when the notification publisher fails.
|
||
Show Confirmation |
Determines whether PingFederate shows a template or state that requires user interaction after clicking a magic link. Select this checkbox if email scanners are in use, or if links are pre-clicked in the user’s inbox through some other means. |
Advanced fields
Field | Description | ||
---|---|---|---|
Magic Link Endpoint |
The endpoint that the magic link goes to. The default value is |
||
Magic Link API Endpoint |
The API endpoint that the front end can use to poll magic link status. The default value is |
||
Test User ID |
The user ID that’s used to test the configuration on the Actions tab. This field is blank by default. |
||
Show Email |
Determines whether the adapter shows the masked email that magic links are sent to in templates and API responses. This checkbox is selected by default. |
||
HTML Template Prefix |
Identifies the HTML templates that the adapter uses.
The default value is |
||
Messages File |
Identifies the customizable language-pack file that the adapter uses for HTML templates.
The default value is |
||
Email Template |
Identifies the email template that the adapter uses to send the magic link.
The default value is |
||
LDAP Search Scope |
When the Attribute Source is an LDAP data store, this setting determines the scope of the user search. Single Level Searches the immediate children of the base object, but excludes the base object itself. Include Subtree (default) Searches all child objects as well as the base object. |