ID DataWeb Integration Kit

Configuring an adapter instance

Configure the ID DataWeb IdP Adapter to determine how PingFederate communicates with the ID DataWeb API.

Steps

  1. In the PingFederate administrative console, create a new IdP adapter instance:

    1. Go to Authentication → Integration → IdP Adapters and 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 ID DataWeb IdP Adapter. Click Next.

  3. Optional: On the IdP Adapter tab, in the Additional Verification Attributes section, configure additional attributes to send to ID DataWeb with the user data.

    1. Click Add a new row to 'Additional Verification 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 ID DataWeb IdP Adapter.

    3. From the ID DataWeb User Attribute list, select the ID DataWeb attribute that you want to populate.

      The ID DataWeb IdP Adapter allows you to pass custom attributes to ID DataWeb. The name and value of the attribute are determined by the Local Attribute column. For example, if you enter officeName in the Local Attribute column, ID DataWeb receives an attribute with the following name and value format: \{…​officeName: headquarters…​}.

    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 ID DataWeb Response Mappings (optional) section, map attributes from the ID DataWeb response to the attribute contract.

    1. Click Add a new row to 'ID DataWeb Response Mappings (optional)'.

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

    3. In the ID DataWeb API Attribute Mapping field, enter the JSON Pointer syntax for the value of the matching ID DataWeb attributes as shown in JSON Pointer syntax reference.

    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 ID DataWeb IdP Adapter settings reference. Click Next.

  6. On the Actions tab, test your connection to the ID DataWeb API. Resolve any issues that are reported, and then click Next.

  7. On the Extended Contract tab, add any attributes that you included in the ID DataWeb Response Mappings (optional) section of the IdP Adapter tab.

  8. On the Adapter Attributes tab, set pseudonym and masking options as shown in Set pseudonym and masking options in the PingFederate documentation. Click Next.

  9. On the Adapter Contract Mapping tab, configure the contract fulfillment details for the adapter as shown in Define the IdP adapter contract in the PingFederate documentation. Click Next.

  10. On the Summary tab, check your configuration and then click Save.