GitHub

Configuring an adapter instance

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

Steps

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

    Choose from:

    • 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.

  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 GitHub IdP Adapter. Click Next.

  3. (Optional) On the IdP Adapter page, 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.

    You can find a list of available attributes in 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.

      Learn more in JSON Pointer syntax reference.

    4. In the Action column, click Update.

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

  4. On the IdP Adapter page, configure the adapter instance by referring to GitHub IdP Adapter settings reference. Click Next.

  5. On the Actions screen, click Test Connection. Resolve any reported issues, then click Next.

  6. On the Extended Contract tab, add any attributes that you want to include in the contract. Click Next.

  7. On the Adapter Attributes tab, set pseudonym and masking options as shown in Set pseudonym and masking options 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 in the PingFederate documentation. Click Next.

  9. On the Summary tab, check and save your configuration:

    Choose from:

    • 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.