Set up a GitHub v2 connector

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 connector 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

Gather GitHub credentials

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

Option 1: Use 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 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.

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. Carefully 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 instance by using a GitHub fine-grained personal access token.

A user with 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.

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. Carefully copy and save the new token.

Option 3: Use a GitHub app

Follow these instructions to integrate your GitHub instance by using a GitHub app.

This process creates a GitHub app that is only available to your GitHub organization, then generates an installation token for that app, which can be used to integrate the GitHub organization with ConductorOne. This creates the equivalent of a personal access token, but does not tie the token to a specific identity.

If you want to integrate multiple GitHub organizations with ConductorOne, you must create an app and set up a connector for each one.

A user with the Org Owner permission in the GitHub organization to be integrated with ConductorOne must perform this task.

1. In GitHub, navigate to Your organizations > Settings.

2. In the left sidebar, select Developer settings.

3. Click GitHub Apps.

4. Click New GitHub App.

5. Give the app a name, such as “ConductorOne integration”.

6. In the Homepage URL field, enter a placeholder URL such as http://example.com. Because this app is not public, it does not have or need a website to direct other users to, so we can use a placeholder URL.

7. In the Callback URL field, enter a placeholder URL such as http://example.com. This app will not use a callback, so we can use a placeholder URL.

8. Check the Expire user authorization tokens and Enable Device Flow checkboxes to enable these settings.

9. In the Webhook section of the page, uncheck the Active checkbox to disable this setting.

10. In the Permissions section of the page, give the app the following permissions:

    • Repository permissions:

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

    • Organization permissions:

      • Members: Read and write access

11. In the Where can this app be installed? section of the page, choose Only on this account. This limits the app’s scope to the GitHub Enterprise organization you’ve set it up on.

12. Click Create GitHub App. The app is created.

13. On the app’s details page, carefully copy and save the App ID.

14. Scroll down to the Private keys section of the app’s page and click Generate a private key.

15. Carefully save the private key file.

That’s it! Next, move on to the connector configuration instructions.

Configure the GitHub connector

To complete this task, you’ll need:

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

# baton-github-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
  name: baton-github-secrets
type: Opaque
stringData:
  # ConductorOne credentials
  BATON_CLIENT_ID: <ConductorOne client ID>
  BATON_CLIENT_SECRET: <ConductorOne client secret>
  
  # GitHub credentials if configuring with an access token
  BATON_TOKEN: <GitHub access token>
  BATON_ORGS: <Optional - list of GitHub orgs that you want to sync>

  # GitHub credentials if configuring with a GitHub app
  BATON_APP_ID: <GitHub app ID>
  BATON_APP_PRIVATEKEY_PATH: <Path to the private key file for the GitHub app>
  BATON_ORGS: <Name of the single GitHib org the app was created for>

  # Optional: include if you want ConductorOne to provision access using this connector
  BATON_PROVISIONING: true

# baton-github.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: baton-github
  labels:
    app: baton-github
spec:
  selector:
    matchLabels:
      app: baton-github
  template:
    metadata:
      labels:
        app: baton-github
        baton: true
        baton-app: github
    spec:
      containers:
      - name: baton-github
        image: ghcr.io/conductorone/baton-github:latest
        imagePullPolicy: IfNotPresent
        envFrom:
        - secretRef:
            name: baton-github-secrets