---
title: Configuring an adapter instance
description: Configure the GitHub IdP Adapter to determine how PingFederate communicates with GitHub.
component: github
page_id: github:github_login_integration_kit:pf_github_cic_configuring_an_adapter_instance
canonical_url: https://docs.pingidentity.com/integrations/github/github_login_integration_kit/pf_github_cic_configuring_an_adapter_instance.html
revdate: November 3, 2025
section_ids:
  steps: Steps
---

# Configuring an adapter instance

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

## 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 **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](pf_github_cic_available_user_attributes.html) and the example JSON payload in [JSON Pointer syntax reference](pf_github_cic_json_pointer_syntax_reference.html).

   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](pf_github_cic_json_pointer_syntax_reference.html).

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

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

4. On the **IdP Adapter** tab, configure the adapter instance by referring to [GitHub IdP Adapter settings reference](pf_github_cic_github_idp_adapter_settings_reference.html). Click **Next**.

5. On the **Actions** tab, 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](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, check your configuration, then click **Save**.