---
title: Configuring an adapter instance
description: Configure the ThreatMetrix IdP Adapter to determine how PingFederate communicates with ThreatMetrix.
component: threatmetrix
page_id: threatmetrix:setup:pf_threatmetrix_ik_configuring_an_adapter_instance
canonical_url: https://docs.pingidentity.com/integrations/threatmetrix/setup/pf_threatmetrix_ik_configuring_an_adapter_instance.html
revdate: October 30, 2025
section_ids:
  steps: Steps
---

# Configuring an adapter instance

Configure the ThreatMetrix IdP Adapter to determine how PingFederate communicates with ThreatMetrix.

## Steps

1. In the PingFederate admin console, go to **Authentication > Integration > IdP Adapters**. Click **Create New Instance**.

2. On the **Type** tab, set the basic adapter instance attributes:

   1. In the **Instance Name** field, enter a name for the adapter instance.

   2. In the **Instance ID** field, enter a unique identifier for the adapter instance.

   3. In the **Type** list, select **ThreatMetrix IdP Adapter**. Click **Next**.

3. (Optional) On the **IdP Adapter** tab, in the **Additional User Attributes** section, configure user attributes to send to ThreatMetrix.

   |   |                                                                                                                                                                                                                                                 |
   | - | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
   |   | You can find a list of user attributes that ThreatMetrix can collect in [Session Query API](https://portal.threatmetrix.com/kb/index.htm#t=implementation%2Fapis%2Fsession_query_api.htm) (requires sign-on) in the ThreatMetrix documentation. |

   1. Click **Add a new row to 'Additional User Attributes'**.

   2. In the **Incoming Attribute Name** field, enter the name of an attribute from any authentication source that appears earlier in your PingFederate authentication policy than the ThreatMetrix IdP Adapter.

   3. In the **ThreatMetrix Attribute** list, select the ThreatMetrix attribute you want to populate.

   4. In the **Action** column, click **Update**.

   5. To add more attributes, repeat steps a - d.

4. (Optional) On the **IdP Adapter** tab, in the **ThreatMetrix API Response Mappings** section, map attributes and sign-on event data from the ThreatMetrix response to the attribute contract.

   These attributes become available in your PingFederate authentication policy.

   1. Click **Add a new row to 'ThreatMetrix API Response Mappings'**.

   2. In the **Local Attribute** field, enter a name of your choosing for an attribute.

   3. In the **ThreatMetrix API Attribute Mapping** field, enter the JSON Pointer syntax for the value of the matching ThreatMetrix attributes.

      Alternately, leave the field blank to include the entire response as the value.

   4. In the **Action** column, click **Update**.

   5. To add more attributes, repeat steps a - d.

5. On the **IdP Adapter** tab, configure the adapter instance by referring to [ThreatMetrix IdP Adapter settings reference](pf_threatmetrix_ik_threatmetrix_idp_adapter_settings_reference.html). Click **Next**.

6. On the **Extended Contract** tab, add any attributes that you included in the **ThreatMetrix API Response Mappings** section of the **IdP Adapter** tab. Click **Next**.

7. On the **Adapter Attributes** tab, set pseudonym and masking options as shown in [Set pseudonym and masking options](https://docs.pingidentity.com/pingfederate/latest/administrators_reference_guide/pf_setting_pseudonym_masking_options.html) in the PingFederate documentation. Click **Next**.

8. On the **Adapter Contract Mapping** tab, configure the contract fulfillment details for the adapter as shown in [Define the IdP adapter contract](https://docs.pingidentity.com/pingfederate/latest/administrators_reference_guide/help_authnadapterinstancetasklet_plugincontractstate.html) in the PingFederate documentation. Click **Next**.

9. On the **Summary** tab, click **Save**.