Configure an instance of the deployed OpenToken Adapter, which uses a secure token format to transfer user attributes between an application and the PingFederate server.
- Go to Manage SP Adapters Instances window. to access the
- Click Create New Instance to start the Create Adapter Instance configuration wizard.
On the Type tab, configure the basics of this adapter
- Enter the Instance Name, Instance ID, and Parent Instance information and select the adapter type from the Type list.
Select a Parent
Instance from the list.
This is useful when you are creating an instance that is similar to an existing instance. The child instance inherits the configuration of its parent. In addition, you have the option to override one or more settings during the rest of the setup. Select the Override ... check box and make the adjustments as needed in one or more subsequent windows.
On the Instance Configuration tab, configure your OpenToken
SP Adapter instance security context.
These values are dependent on your developer's implementation.
For more information, see the Description field provided in-window and in the following table.
PingFederate's field names and descriptions for creating an adapter instance Field Description Password
The password to use for generating the encryption key. It is also known as the shared secret.
Click Show Advanced Fields in the Instance Configurationtab to review the following settings. Modify as needed.
Transport Mode How the token is transported to and from the application, either through a query parameter, a cookie, or as a form POST (default). Token Name The name of the cookie or query parameter that contains the token. This name must be unique for each adapter instance. Override the default value
Cipher Suite The algorithm, cipher mode, and key size that should be used for encrypting the token. The default selected value is AES-128/CBC. Authentication Service The URL to which the user is redirected for a single sign-on (SSO) event. This URL overrides the Target Resource, which is sent as a parameter to the Authentication Service. Account Link Service The URL to which the user is redirected for account linking. This URL is part of an external SP application. This external application performs user authentication and returns the local user ID inside the token. Logout Service The URL to which the user is redirected for a single-logout event. This URL is part of an external application, which terminates the user session. Cookie Domain The server domain; for example,
example.com. If no domain is specified, the value is obtained from the request.
Cookie Path The path for the cookie that contains the token. Token Lifetime
The duration in seconds for which the token is valid. Valid range is 1 to 28800. The default value is
The duration in seconds for which the token may be re-issued without authentication. Valid range is 1 to 259200. The default value is
43200, 12 hours.
Not Before Tolerance
The amount of time in seconds to allow for clock skew between servers. Valid range is 0 to 3600. The default value is
Force SunJCE Provider If selected, the SunJCE provider is forced for encryption/decryption. Use Verbose Error Messages If selected, use verbose TokenException messages. Obfuscate Password If selected, the default, the password is obfuscated and password-strength validation is applied. Clearing the check box allows backward compatibility with previous OpenToken agents. Session Cookie If selected, OpenToken is set as a session cookie rather than a persistent cookie. Applies only if the Transport Mode field is set to Cookie. The check box is not selected by default. Secure Cookie If selected, the OpenToken cookie is set only if the request is on a secure channel (https). Applies only if the Transport Mode field is set to Cookie. The check box is not selected by default. Send Subject as Query Parameter Selecting this check box sends the user identifier subject as a clear-text query parameter, if the Transport Mode field is set to Query Parameter. If Form POST is the chosen token transport mode, the user identifier is sent as POST data. Subject Query Parameter The parameter name used for the user identifier when the Send Subject ID as Query Parameter check box is selected. Send Extended Attributes Extended Attributes are typically sent only within the token, but this option overrides the normal behavior and allows the attributes to be included in browser cookies or query parameters. Skip Trimming of Trailing Backslashes If not selected, the default, it prevents insecure content from affecting the security of your application and the agent. Update your applications with the latest version of the agent. We recommend not to change the value of this flag to avoid a negative security impact, such as someone maliciously adding slashes to exploit the system. URL Encode Cookie Values If checked, the extended attribute cookie value will be URL encoded.
In the Actions tab, click Download
under Action section. Click Export to
save the properties file.
The values in the resulting file, agent-config.txt, represent the console configuration and are used by the SP application. See the documentation of your respective integration kit for more information.
- Optional: In the Extended Contract tab, configure additional attributes for this adapter instance.
- In the Summary tab, review your configuration, modify as needed. Click Done.
On the SP Adapters window, click
Save to confirm the adapter instance configuration.
If you want to exit without saving the configuration, click Cancel.