GitHub versus GitHub Enterprise: which integration should I use? Follow the instructions on this page if your organization accesses GitHub at a custom domain.

If you at access GitHub at github.com, go to the GitHub integration.

Capabilities

Available hosting methods

Choose the hosting method that best suits your needs:

Gather GitHub Enterprise credentials

Each setup method requires you to pass in credentials generated in GitHub Enterprise. Gather these credentials before you move on. To set up the GitHub Enterprise connector, you can choose to create either a personal access token (classic) or a fine-grained access token.

Option 1: Use a personal access token (classic)

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

A user with Org Owner access in GitHub Enterprise 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.

1. In GitHub Enterprise, 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 Enterprise 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 Enterprise 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.

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

Option 2: Use a fine-grained access token

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

A user with Org Owner access in GitHub Enterprise must perform this task.

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

1. In GitHub Enterprise, 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 Enterprise accounts. If you do not want ConductorOne to sync and display your GitHub Enterprise organization’s repo data, do not give your token these permissions.

9. Click Generate token. Copy and save the new token.

That’s it! Next, move on to the instructions for your chosen setup method.

Set up a GitHub Enterprise cloud-hosted connector

To complete this task, you’ll need:

• The Connector Administrator or Super Administrator role in ConductorOne
• Access to the set of GitHub Enterprise credentials generated by following the instructions above

1. In ConductorOne, click Connectors > Add connector.

2. Search for GitHub Enterprise and click Add.

3. Choose how to set up the new GitHub Enterprise 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

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.

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

5. Click Next.

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

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

8. Paste the token you generated into the Personal access token field.

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

10. Click Save.

11. 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 Enterprise connector is now pulling access data into ConductorOne.

Set up a GitHub Enterprise cloud-hosted connector using Terraform

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

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