Getting Started with GitHub SSO

Enable SSO for SSH Keys and Tokens

To get set up with GitHub SSO, there are a couple of settings a user must configure on their account. Follow the below instructions; failure to do so may cause access issues with some GitHub functionality, such as project deploy/user SSH keys, ability to initiate pipelines and edit config, etc.

  1. Log into GitHub and navigate to your user’s Settings → SSH and GPG keys (direct link here).
  2. For each key used in one or more protected orgs, Configure SSO Authorize the org(s) so that the key can access protected resources:

    Screen_Shot_2021-11-23_at_1.39.17_PM.png

  3. These SSH keys should now have access to the protected orgs. No further action within CircleCI is required.

Enabling SSO for Tokens and Apps

If using GitHub personal access tokens in your CircleCI pipelines, you’ll also need to Enable SSO for each token. Follow the same steps as above:

  1. Go to Settings → Developer Settings → Personal access tokens
  2. Follow the same steps as described above to enable protected org access for these tokens.

Common Issues

See our support article here for troubleshooting common SSO/SAML-related issues for user GitHub OAuth credentials (used for most interactions with CircleCI, including creating pipelines on new commits).

For troubleshooting issues with GitHub SSH keys and personal access tokens, see the above sections.

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.