Standard fields
Field Description

PingOne Environment

For PingFederate 10.2 and later.

Select the PingOne connection that you created in Connecting PingFederate to PingOne.

This field is blank by default.

PingOne Population

For PingFederate 10.2 and later.

If a user does not already exist in PingOne, the adapter provisions the user to this PingOne population.

Applies only when Provision User is selected.

This list is populated after you select the PingOne Environment.

This field is blank by default.

Verify Policy

 The name of the verify policy. This list is populated when you select a PingOne environment.

Email Chained Attribute

Name of the incoming chanied attribute that contains the user's email address.

The default value is mail.

Phone Chained Attribute

Name of the incoming chained attribute that contains the user's phone number.

The default value is mobile.

Reference Image Chained Attribute

The name of the incoming chained attribute that contains the user's reference image. A reference image as base64-encoded string is required for thefacial comparison only Verify policy.

The default value is photo.

Verification URL Delivery Method

Delivery method for the user to start verification.

The default value is User selection.

Environment ID

For PingFederate 10.1 and earlier.

The environment ID that you noted in Connecting PingFederate to PingOne.

This field is blank by default.

Region

For PingFederate 10.1 and earlier.

Determines the PingOne API that the adapter communicates with.

Select the region that appears on Settings > Environment > Properties in PingOne.

PingFederate Connection Client ID

For PingFederate 10.1 and earlier.

The client ID that you noted in Connecting PingFederate to PingOne. This is required for automatic device pairing.

This field is blank by default.

PingFederate Connection Client Secret

For PingFederate 10.1 and earlier.

The client secret that you noted in Connecting PingFederate to PingOne. This is required for automatic device pairing.

This field is blank by default.

Population ID

For PingFederate 10.1 and earlier.

If a user does not already exist in PingOne, the adapter provisions the user to this PingOne population. Your population ID appears on Identities > Populations in PingOne.

Applies only when Provision User is selected.

This field is blank by default.
Advanced fields
Field Description

Test Username

The PingOne username that the adapter uses to test the PingOne Verify connection on the Actions tab.

This field is blank by default.

HTML Template Prefix

Identifies the set of HTML templates that the adapter uses to show the authentication status or request a one-time passcode (OTP).

If you customize the template file names in the /server/default/conf/template directory, enter the new prefix here.

For a description of the template files, see Download manifest.

The default value is pingone-verify.

Messages Files

Identifies the customizable language-pack file that the adapter uses to show messages on the templates.

If you customize the pingone-verify-messages.properties file name in the /server/default/conf/language-packs directory, enter the new name here.

The default value is pingone-verify-messages.

Error Message Key Prefix

Identifies the error messages in the language-pack file that the adapter uses to show messages on the templates.

If you customize the error message names in /server/default/conf/language-packs/pingone-verify-messages.properties, enter the new prefix here.

The default value is pingone.verify.error..

Provision User

If a user does not already exist in PingOne, the adapter provisions the user to PingOne.

This check box is selected by default.

Allow Verification Retries

When ID verification fails, this setting determines whether a user can try again. Your PingOne Verify configuration determines the maximum number of retry attempts.

This check box is cleared by default.

Reset Verification Status

Require ID verification for every authentication by resetting the user's status.

This check box is cleared by default.

User Not Found Failure Mode

When a user error occurs in PingOne, this setting determines whether the adapter blocks the user’s sign-on or registration attempt.

User errors include the following:
  • User is disabled
  • User does not exist
  • User cannot be provisioned
  • The PingOne Verify service is disabled for the user

The default selection is Block user.

Service Unavailable Failure Mode

When PingOne does not respond, this setting determines whether the adapter blocks the user’s sign-on or registration attempt.

The default selection is Bypass authentication.

Show Success Screens

Determines whether the adapter shows a success page when the verification process is successful.

This check box is selected by default.

Show Error Screens

Determines whether the adapter shows an error page when the verification process fails and the user cannot retry.

This check box is selected by default.

Show Timeout Screens

Determines whether the adapter shows a "timed out" page when the verification process times out.

This check box is selected by default.

State Timeout

The amount of time in seconds that the adapter allows for each state of the process when waiting for a user to complete the verification process.

The default value is 1200.

The minimum value is 60.

API Request Timeout

The amount of time in milliseconds that PingFederate allows when establishing a connection with PingOne Verify or waiting for a response to a request. A value of 0 disables the timeout.

The default value is 5000.

Proxy Settings

Defines proxy settings for outbound HTTP requests.

The default value is System Defaults.

Custom Proxy Host

The proxy server host name to use when Proxy Settings is set to Custom.

This field is blank by default.

Custom Proxy Port

The proxy server port to use when Proxy Settings is set to Custom.

This field is blank by default.