A newer version of this connector is available. If you’re setting up a GitHub connector with C1 for the first time, use the v2 version. Availability
An updated version of this integration is available. This version of the connector is no longer available for new installation. If you’re integrating GitHub for the first time, use the updated version.
Capabilities
-
Sync user identities from GitHub to C1
-
Resources supported:
- Repositories
- Teams (including nested teams)
- Orgs
-
Provisioning supported:
Requirements
Connecting to your GitHub environment, you will need:
- Super Administrator role in C1
- Org Owner access in GitHub
Set up the GitHub integration
This task requires either the Connector Administrator or Super Administrator role in C1.
In C1, navigate to Integrations > Connectors > GitHub.
If this is your first GitHub integration, the integration form opens automatically. Otherwise, click Add connector.
Choose whether to add the new GitHub connector as a data source to an existing application (and select the app of your choice) or to create a new application.Do you SSO into GitHub using your identity provider (IdP)? If so, make sure to add the connector to the GitHub app that was created automatically when you integrated your IdP with C1, rather than creating a new app.
Set the owner for this connector. You can manage the connector yourself, or choose someone else from the list of C1 users. Setting multiple owners is allowed.A GitHub connector owner must have the following permissions:
- Connector Administrator or Super Administrator role in C1
- Org Owner access in GitHub
Next steps
-
If you are the integration owner, proceed to Integrate your GitHub instance [chosen method] for instructions on integrating GitHub with C1.
-
If someone else is the integration owner, C1 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 C1: 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 C1 and Org Owner access in GitHub must perform this task.
Step 1: Create a GitHub personal access token (classic)
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, C1 Integration). Optionally, add a token expiration date.
Select the following Scopes:
- repo - select all
- admin:org - select all if using C1 for GitHub provisioning (see the note below), or read::org otherwise
- user - select all
The write::org scope is used by C1 when automatically provisioning and deprovisioning GitHub access on your behalf. If you do not want C1 to perform these tasks for you, do not give your token this scope.
Click Generate token. Copy and save the new token. We’ll use it in Step 3.
Step 2: Locate your GitHub organization name
In GitHub, click your profile photo, then click Organizations.
Make a note of your Organization name. We’ll use it in Step 3. Step 3: Add your GitHub credentials to C1
In C1, navigate to Integrations > Connectors > GitHub.
In the list of connectors, locate and click on the name of the connector with the Not connected label.
Find the Settings area of the page and click Edit.
In the Organization field, enter the name of your GitHub organization.
Paste the token you generated in Step 1 into the Personal access token field.
The connector’s label changes to Syncing, followed by Connected. You can view the logs to ensure that information is syncing.
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 C1 and Org Owner access in GitHub must perform this task.
Step 1: Create a GitHub fine-grained access token
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, C1 Integration) and set a token expiration date. Optionally, add a description.
In the Resource owner dropdown, select the username associated with the GitHub organization you’re integrating with C1.
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
-
Repository permissions:
- Administration: Read and write access
- Metadata: Read-only access
The repository permissions are used by C1 to sync and display data on repo membership (C1 cannot provision repositories). If you do not want C1 to sync and display your GitHub organization’s repo data, do not give your token these permissions.
Click Generate token. Copy and save the new token. We’ll use it in Step 3.
Step 2: Locate your GitHub organization name
In GitHub, click your profile photo, then click Organizations.
Make a note of your Organization name. We’ll use it in Step 3.
Step 3: Add your GitHub credentials to C1
In C1, navigate to Integrations > Connectors > GitHub.
In the list of connectors, locate and click on the name of the connector with the Not connected label.
Find the Settings area of the page and click Edit.
In the Organization field, enter the name of your GitHub organization.
Paste the token you generated in Step 1 into the Personal access token field.
The connector’s label changes to Syncing, followed by Connected. You can view the logs to ensure that information is syncing.
