GitHub

Registering PingFederate as an OAuth application in GitHub

To allow PingFederate to process social sign-on requests with GitHub, add PingFederate as an OAuth application in the GitHub administrative console.

Steps

  1. Sign on to the GitHub App settings page using a GitHub account.

  2. Click the OAuth Apps tab, then click New OAuth app.

  3. On the Register a new OAuth app page:

    1. In the Application name field, enter a name, such as PingFederate.

    2. In the Homepage URL, enter the hostname (or virtual hostname) and port of your PingFederate server, such as https://pf.example.com:9031.

    3. (Optional) In the Application Description field, enter a description of the application.

    4. In the Authorization callback URL field, enter the hostname (or virtual hostname) and port of your PingFederate server followed by the GitHub IdP Adapter instance endpoint, such as https://pf.example.com:9031/ext/github-authn.

      The default endpoint is /github-authn. If you set a custom endpoint here, enter the matching value in the Authorization Callback Endpoint field of your adapter instance configuration in Configuring an adapter instance.

    5. (Optional) If you want to use GitHub’s device flow to perform additional authorization, select the Enable Device Flow checkbox.

      You can find more information in Device Flow in the GitHub documentation.

      Using device flow isn’t required to include the GitHub authentication API in the SSO flow.

    6. Click Register application.

  4. On the OAuth application page, note the Client ID field, then enter the hostname (or virtual hostname and Client Secret) to use in Configuring an adapter instance.