Skip to main content

Configure GitHub Enterprise connector

The Snow Integration Connector for GitHub Enterprise is used to determine the number of registered GitHub users.

The configuration must be started and prepared according to SaaS connector configuration.

Prerequisites

A GitHub Enterprise user account is required to connect to the GitHub Enterprise API, and extract the number of users and their last login date. The GitHub Enterprise user account must have the role Site Admin with read permission for the user scope, to be able to connect to the GitHub Enterprise API and extract user data. The GitHub Enterprise connector supports both cloud and self-hosted instances of GitHub Enterprise.

Note

GitHub's own cloud-hosting service API on GitHub.com does not meet the requirements for a SIM connector and hence is not supported.

Generate and get the token

Snow Integration Manager integrates with GitHub Enterprise via a unique token.

  1. Log in to GitHub Enterprise using a user account with the Site Admin role.

  2. Select Developer settings.

  3. Select Personal access tokens.

  4. Select the following Permissions:

    • read:user: To get individual user details.

    • user:email: To get user email.

    • read:audit_log: To get read access of the audit log.

      Note

      This permission is required if you select the Audit Log API for the Last Activity Source, during connector configuration.

  5. Select Generate new token.

  6. Enter a memorable Token description.

  7. Select user.

  8. Select Generate token.

  9. Select and copy the personal access token.

Caution

We recommend you to save the token securely as you will be unable to view it again once created. A new token can be created and used if the token is lost.

Procedure

In the Configure GitHub Enterprise section at the bottom of Connector Configuration: SaaS, do the following.

  1. In the Access token, paste the copied personal access token, as saved in Generate and get the token.

  2. In Endpoint, enter the network address for your GitHub Enterprise instance.

  3. In Last Activity Source, to configure your preferred APIs, do one of the following:

    • Select Events API (Public Events Only). For an existing GitHub connector user, this is the default option provided.

    • To retrieve your activity data for both public and private events, select Audit Log API (All Events) and then enter the Enterprise Name.

      1. To access the Enterprise Name, navigate to your enterprise server instance using .

      2. Locate and copy the {enterprise-name} from the last part of the resulting URL.

      3. Paste the value in the field in SIM.

      Note

      • Selecting the Audit Log API enables the Enterprise Name field.

      • The Audit Log API can be used only for GitHub Enterprise Server versions 3.x and above.

  4. To verify that the connection between Snow Integration Manager and the GitHub Enterprise API is successful, select Test Connection.

  5. To enable the connector, select Active.

  6. Select Save.

In this section: