Configuring an adapter instance

Page created: 30 Sep 2019 |

Page updated: 8 Feb 2022

| 2 min read

GitHub Other Documents Integrations Language English Integration Content Type Product documentation Audience Administrator

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

In the PingFederate administrative console, create a new IdP adapter instance:
- For PingFederate 10.1 or later: go to Authentication > Integration > IdP Adapters. Click Create New Instance.
- For PingFederate 10.0 or earlier: go to Identity Provider > Adapters. Click Create New Instance.
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. From the Type list, select GitHub IdP Adapter. Click Next.
Optional: On the IdP Adapter screen, in the Optional GitHub Attributes section, override or add to the default mappings between local attributes and the attributes from the core or extended contract.

For a list of available attributes, see Available user attributes and the example JSON payload in JSON Pointer syntax reference.
1. Click Add a new row to 'Optional GitHub Attributes'.
2. In the Local Attribute field, enter the name of a local attribute.
3. In the GitHub Attribute field, enter the JSON Pointer syntax for the value of the matching GitHub attribute. See JSON Pointer syntax reference.
4. In the Action column, click Update.
5. To add more attributes, repeat steps a-d.
On the IdP Adapter screen, configure the adapter instance by referring to GitHub IdP Adapter settings reference. Click Next.
On the Actions screen, click Test Connection. Resolve any issues that are reported, and then click Next.
On the Extended Contract tab, add any attributes that you want to include in the contract. Click Next.
On the Adapter Attributes tab, set pseudonym and masking options as shown in Set pseudonym and masking options in the PingFederate documentation. Click Next.
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.
On the Summary tab, check and save your configuration:
- For PingFederate 10.1 or later: click Save.
- For PingFederate 10.0 or earlier: click Done. On the Manage IdP Adapter Instances tab, click Save.