This is an updated and improved version of the GitHub integration! The v2 version of the GitHub integration adds provisioning support for repositories and modernizes the underlying architecture. If you’re setting up a GitHub integration with ConductorOne for the first time, you’re in the right place.

Use this integration if your organization accesses GitHub at github.com. If you use a custom domain, follow the instructions to set up the GitHub Enterprise integration.

Capabilities

• Sync user identities from GitHub to ConductorOne

• Resources supported:

  • Repositories
  • Teams
  • Orgs

• Provisioning supported:

  • Repositories
  • Teams
  • Orgs

Add a new GitHub connector

This task requires either the Connector Administrator or Super Administrator role in ConductorOne.

1. In ConductorOne, click Connectors > Add connector.

2. Search for GitHub v2 and click Add.

3. Choose how to set up the new GitHub connector:

   • Add the connector to a currently unmanaged app (select from the list of apps that were discovered in your identity, SSO, or federation provider that aren’t yet managed with ConductorOne)

   • Add the connector to a managed app (select from the list of existing managed apps)

   • Create a new managed app

   Do you SSO into GitHub using your identity, SSO, or federation provider? If so, make sure to add the connector to the unmanaged GitHub app that was created automatically when you integrated your provider with ConductorOne, rather than creating a new managed app.

4. Set the owner for this connector. You can manage the connector yourself, or choose someone else from the list of ConductorOne users. Setting multiple owners is allowed.

   A GitHub connector owner must have the following permissions:

   • Connector Administrator or Super Administrator role in ConductorOne
   • Org Owner access in GitHub

5. Click Next.

Next steps

• If you are the connector owner, proceed to Integrate your GitHub instance [chosen method] for instructions on integrating GitHub with ConductorOne.

• If someone else is the connector owner, ConductorOne will notify them by email that their help is needed to complete the setup process.

Choose the appropriate set of integration instructions based on the type of GitHub access token you want to use with ConductorOne:

• Option 1: Use a Personal access token (classic)

• Option 2: Use a Fine-grained personal access token

Option 1: Integrate your GitHub instance using a personal access token (classic)

Follow these instructions to integrate your GitHub instance by using a GitHub personal access token (classic).

A user with the Connector Administrator or Super Administrator role in ConductorOne and Org Owner access in GitHub must perform this task.

If you’re using SAML single sign-on, avoid a You must grant your Personal Access token access to this organization error by following the Authorizing a personal access token for use with SAML single sign-on instructions in the GitHub documentation.

Step 1: Create a GitHub personal access token (classic)

1. In GitHub, click your profile photo, then click Settings.

2. In the left sidebar, select Developer settings.

3. Click Personal access tokens > Tokens (classic).

4. Click Generate new token > Generate new token (classic).

5. Name your token (for example, ConductorOne Integration). Optionally, add a token expiration date.

6. Select the following Scopes:

   • repo - select all
   • admin:org - select all if using ConductorOne for GitHub provisioning (see the note below), or read::org otherwise
   • user - select all

   The write::org scope is used by ConductorOne when automatically provisioning and deprovisioning GitHub access on your behalf. If you do not want ConductorOne to perform these tasks for you, do not give your token this scope.

7. Click Generate token. Copy and save the new token. We’ll use it in Step 2.

If you use SAML SSO, you must authorize the PAT using these instructions.

Step 2: Add your GitHub credentials to ConductorOne

1. In ConductorOne, navigate to the GitHub connector by either:

   • Clicking the Set up connector link in the email you received about configuring the connector.

   • Navigate to Connectors > GitHub v2 (if there is more than one GitHub v2 listed, click the one with your name listed as owner and the status Not connected).

2. Find the Settings area of the page and click Edit.

3. In the Instance URL field, enter the URL of your GitHub instance.

4. Paste the token you generated in Step 1 into the Personal access token field.

5. Optional. If you want to sync only specific GitHub organizations, enter the organizations’ names in the Orgs field. If you do not specify specific organizations, ConductorOne will sync all organizations.

6. Click Save.

7. The connector’s label changes to Syncing, followed by Connected. You can view the logs to ensure that information is syncing.

That’s it! Your GitHub connector is now pulling access data into ConductorOne.

Option 2: Integrate your GitHub instance using a fine-grained access token

Follow these instructions to integrate your GitHub instance by using a GitHub fine-grained personal access token.

A user with the Connector Administrator or Super Administrator role in ConductorOne and Org Owner access in GitHub must perform this task.

Before you begin: Make sure that your GitHub organization is set up to allow use of fine-grained personal access tokens by following the GitHub documentation on Setting a personal access token policy for your organization.

Step 1: Create a GitHub fine-grained access token

1. In GitHub, click your profile photo, then click Settings.

2. In the left sidebar, select Developer settings.

3. Click Personal access tokens > Fine-grained tokens.

4. Click Generate new token.

5. Name your token (for example, ConductorOne Integration) and set a token expiration date. Optionally, add a description.

6. In the Resource owner dropdown, select a resource owner. The token is able to access resources owned by the selected resource owner. Organizations will not appear unless they have opted in to fine-grained personal access tokens.

7. In the Repository access section of the page, select All repositories.

8. In the Permissions section of the page, give the token the following permissions:

   • Organization permissions:

     • Members: Read and write access

   • Repository permissions:

     • Administration: Read and write access
     • Metadata: Read-only access

   The repository permissions are used by ConductorOne to sync and display data on repo membership, and to provision repository permissions for GitHub accounts. If you do not want ConductorOne to sync and display your GitHub organization’s repo data, do not give your token these permissions.

9. Click Generate token. Copy and save the new token. We’ll use it in Step 2.

Step 2: Add your GitHub credentials to ConductorOne

1. In ConductorOne, navigate to the GitHub connector by either:

   • Clicking the Set up connector link in the email you received about configuring the connector.

   • Navigate to Connectors > GitHub v2 (if there is more than one GitHub v2 listed, click the one with your name listed as owner and the status Not connected).

2. Find the Settings area of the page and click Edit.

3. Paste the token you generated in Step 1 into the Personal access token field.

4. Click Save.

5. The connector’s label changes to Syncing, followed by Connected. You can view the logs to ensure that information is syncing.

That’s it! Your GitHub connector is now pulling access data into ConductorOne.

Configure the GitHub integration using Terraform

As an alternative to the integration process described above, you can use Terraform to configure the integration between GitHub and ConductorOne.

See the ConductorOne GitHub v2 integration resource page in the ConductorOne Terraform registry for example usage and the full list of required and optional parameters.