The Passthrough IdP Adapter allows a user key to be associated with a user's authentication sessions.
By placing the Passthrough IdP Adapter downstream from an IdP connection in a policy tree, you
can take advantage of additional capabilities associated with defining a user key.
For example, you can use the user key to query or
revoke a user's authentication sessions. The adapter automatically sets
username attribute in its core contract to match the configured
incoming user ID. With an upstream IdP
connection, the incoming user ID can be mapped to the connection's
- Go to .
- On the IdP Adapters window, click Create New Instance to start the Create Adapter Instance configuration.
On the Type tab, configure the basics of this adapter
- Enter the Instance Name and Instance ID.
- In the Type list, select Passthrough IdP Adapter.
In the Parent Instance list, select an existing
If you are creating an instance that is similar to an existing instance, consider making it a child instance by specifying a parent. A child instance inherits the configuration of its parent unless overridden. You can specify overrides during the rest of the setup.
- On the IdP Adapter tab, there are no configurable fields, so skip to the Extended Contract tab.
- On the Extended Contract tab, you can extend the contract by entering the name of the desired attribute and clicking Add. You can add multiple attributes.
On the Adapter Attributes tab, do the following:
From the Unique User Key Attribute list, select
an attribute to uniquely identify users signing on with this
The attribute's value is used to identify user sessions across all adapters. None is selected by default.Note:
If you choose a custom user key attribute, PingFederate uses the value of the attribute after the Adapter Contract Mapping (if any) has been evaluated. If you choose a custom user key attribute that is based on the username, configure the adapter's password credential validators to trim spaces.
Select the check box under Pseudonym for the
user identifier of the adapter and optionally for the other attributes,
This selection is used if any of your service provider (SP) partners use pseudonyms for account linking.Note:
A selection is required whether or not you use pseudonyms for account linking. This allows account linking to be used later without having to delete and reconfigure the adapter. Ensure that you choose at least one attribute that is unique for each user, such as a user's email, to prevent assigning the same pseudonym to multiple users.
Select the check box under Mask Log Values for
any attributes whose values you want PingFederate to mask in its logs at
Masking is not applied to the unique user key attribute in the logs even though the attribute used for the key is marked as Mask Log Values.
- Select the Mask all OGNL-expression generated log values check box if OGNL expressions might be used to map derived values into outgoing assertions and you want those values masked.
- Optional: From the Unique User Key Attribute list, select an attribute to uniquely identify users signing on with this adapter.
On the Adapter Contract Mapping tab, configure the adapter
contract for this instance with the following optional workflows:
- Configure one or more data sources for datastore queries.
- Fulfill adapter contract with values from the adapter, the default, datastore queries, if configured, context of the request, text, or expressions, if enabled.
- Set up the Token Authorization framework to validate one or more criteria prior to the issuance of the adapter contract.
- On the Summary tab, review your configuration and modify as needed. Click Save.