Set up a GitHub 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

Resource	Sync	Provision
Accounts
Repositories
Teams
Orgs
Secrets - API keys

The GitHub connector supports automatic account provisioning and deprovisioning. New accounts will send an invitation to the account owner; if an invitation is pending, the account status will be shown as Unspecified. Repository permissions that are inherited through team membership are labeled as such on the relevant entitlement’s Grants tab in the ConductorOne web app. This connector can sync secrets and display them on the Inventory page.

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. You must set up the connector with a GitHub app to have the option of syncing secrets.

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.

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

In the left sidebar, select Developer settings.

Click Personal access tokens > Tokens (classic).

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

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

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.

Click Generate token. Carefully copy and save the new token.

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

That’s it! Next, move on to the connector configuration 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.

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

In the left sidebar, select Developer settings.

Click Personal access tokens > Fine-grained tokens.

Click Generate new token.

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

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.

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

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

Organization permissions:
- Members: Read and write access
- Custom organization roles: 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.

Click Generate token. Carefully copy and save the new token.

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

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.

In GitHub, navigate to Your organizations > Settings.

In the left sidebar, select Developer settings.

Click GitHub Apps.

Click New GitHub App.

Give the app a globally unique name, such as “c1-integration-<org name>”. There is a 34 character limit.

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.

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.

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

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

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:
- Custom organization roles: Read and write access
- Members: Read and write access

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.

Click Create GitHub App. The app is created.

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

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

Carefully save the private key file.

Finally, install the new app on your GitHub organization. Navigate to Developer Settings > GitHub Apps.

Find your app and click Edit > Install App.

Click Install next to the GitHub organization where you want to install the app.

Select the repositories the app can act on.

Click Install.

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

Cloud-hosted
Self-hosted

Follow these instructions to use a built-in, no-code connector hosted by ConductorOne.

In ConductorOne, navigate to Admin > Connectors and click Add connector.

Search for GitHub v2 and click Add.

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

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.

Click Next.

Find the Settings area of the page and click Edit.

If you’re using a personal access token to set up the connector:

Click Personal access token.
Paste the token you generated into the Personal access token field.
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.
Optional. If you do not want to include archived repos in syncs, click to enable Omit archived repositories.

If you’re using a GitHub app to set up the connector:

Click GitHub app.
Enter your app ID into the GitHub app ID field.
Click Choose file and upload your private key file.
In the Organization field, enter the name of the GitHub organization associated with the GitHub app. You must enter a single organization name in this field or the connector configuration will fail.
Optional. Click to enable Sync secrets. Synced secrets are displayed on the Inventory page.
Optional. If you do not want to include archived repos in syncs, click to enable Omit archived repositories.

Click Save.

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.

Follow these instructions to use the GitHub connector, hosted and run in your own environment.When running in service mode on Kubernetes, a self-hosted connector maintains an ongoing connection with ConductorOne, automatically syncing and uploading data at regular intervals. This data is immediately available in the ConductorOne UI for access reviews and access requests.

Step 1: Set up a new GitHub connector

In ConductorOne, navigate to Connectors > Add connector.

Search for Baton and click Add.

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

Click Next.

In the Settings area of the page, click Edit.

Click Rotate to generate a new Client ID and Secret.Carefully copy and save these credentials. We’ll use them in Step 2.

Step 2: Create Kubernetes configuration files

Create two Kubernetes manifest files for your GitHub connector deployment:

Secrets configuration

# 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

  # Optional: include if you do not want to sync archived repos
  BATON_OMIT_ARCHIVED_REPOSITORIES: true

See the connector’s README or run --help to see all available configuration flags and environment variables.

Deployment configuration

# 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
        env:
        - name: BATON_HOST_ID
          value: baton-github
        envFrom:
        - secretRef:
            name: baton-github-secrets

Step 3: Deploy the connector

Create a namespace in which to run ConductorOne connectors (if desired), then apply the secret config and deployment config files.

Check that the connector data uploaded correctly. In ConductorOne, click Applications. On the Managed apps tab, locate and click the name of the application you added the GitHub connector to. GitHub data should be found on the Entitlements and Accounts tabs.

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

Welcome

Build connectors

Configure connectors

Deploy connectors

Upload connector data

Connector library

Set up a GitHub connector

Capabilities

Gather GitHub credentials

Option 1: Use a personal access token (classic)

Option 2: Use a fine-grained access token

Option 3: Use a GitHub app

Configure the GitHub connector

Step 1: Set up a new GitHub connector

Step 2: Create Kubernetes configuration files

Secrets configuration

Deployment configuration

Step 3: Deploy the connector

Welcome

Build connectors

Configure connectors

Deploy connectors

Upload connector data

Connector library

​Capabilities

​Gather GitHub credentials

​Option 1: Use a personal access token (classic)

​Option 2: Use a fine-grained access token

​Option 3: Use a GitHub app

​Configure the GitHub connector

​Step 1: Set up a new GitHub connector

​Step 2: Create Kubernetes configuration files

​Secrets configuration

​Deployment configuration

​Step 3: Deploy the connector

Capabilities

Gather GitHub credentials

Option 1: Use a personal access token (classic)

Option 2: Use a fine-grained access token

Option 3: Use a GitHub app

Configure the GitHub connector

Step 1: Set up a new GitHub connector

Step 2: Create Kubernetes configuration files

Secrets configuration

Deployment configuration

Step 3: Deploy the connector