PingOne Credentials IdP Adapter settings reference

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.

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.

Digital Wallet Application

The name of the application that captures the mobile application attributes for the wallet. This list is populated when you select a PingOne Environment.

App Consent Prompt

The message prompt that’s shown to the user in the app before they consent to the presentation request.

The default value is Please accept.

Presentation Protocol

The presentation protocol that the app should use to complete the presentation request. Available options are:

Refresh Interval

The interval, in milliseconds, at which the adapter checks if the credential has been shared.

The default value is 5000.

Cookie Signing Key

The key that the adapter uses to sign application instance ID cookies. This value can’t exceed 1000 characters.

The default value is some-secret-key.

HTML Template Prefix

Identifies the set of HTML templates that the adapter uses.

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

The default value is pingone-credentials.

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

Messages Files

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

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

The default value is pingone-credentials-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-credentials-messages.properties, enter the new prefix here.

The default value is pingone.credentials.error..

Allow Credential Verification Retries

When credential verification fails, this setting determines whether to start a new session.

This check box is cleared by default.

Enable Application Instance Cookie

On credential verification success, this setting sets the application instance cookie so that future sessions in the same browser are prompted for sharing credentials automatically, without requiring QR scanning.

Disabling this setting requires QR scanning for every session.

This check box is selected by default.

Service Unavailable Failure Mode

When the adapter is unable to access PingOne, this setting determines whether the adapter should block the user’s sign-on attempt or bypass authentication.

The default selection is Bypass authentication.

Show Success Screens

When the presentation session is successful, this setting determines whether the adapter shows a success page.

This check box is selected by default.

Show Failed Screens

When the presentation session fails, this setting determines whether the adapter shows a failure page.

This check box is selected by default.

Show Timeout Screens

When a presentation session times out, this setting determines whether the adapter shows a timeout page.

This check box is selected by default.

State Timeout

The amount of time in seconds that the adapter will stay in the same presentation session state before the adapter times out.

The default value is 300.

The minimum value is 60.

API Request Timeout

The amount of time in milliseconds that PingFederate allows when establishing a connection with PingOne Credentials 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.