Skip to main content
 

You must have:

  • A GitHub Enterprise account license. For more information, see GitHub's products.

  • Access to audit log GraphQL API. Expel polls events from the GraphQL API using a Personal Access Token.

Note

This procedure is specifically for cloud-hosted GitHub deployments. For on-prem, use the GitHub self-hosted (on-prem) Workbench setup guide.

Step 1: Install the cloud-hosted GitHub App

Expel uses a GitHub App as part of the onboarding process. During installation, the Expel GitHub App receives the following organization-level privileges:

  • Members: Read+Write

  • Administration: Read-Only

Note

GitHub doesn't log user identities, making it difficult to track suspicious activity at the user level. To solve this problem, Expel uses Write Permissions to map GitHub data to a user's identity.

  1. Navigate to the Expel GitHub Integration Application installation page: https://github.com/apps/expelgithubintegration and click Install.

    mceclip0.png
  2. Follow the steps to install the application within the GitHub Organization you want to onboard.

    Note

    If you have multiple organizations, create a separate Security Device in Workbench for each organization.

  3. After you successfully install the application, note the Installation ID that can be found in your URL under the format "github.com/.../installations/<installation_id>/…"

Step 2: Configure the technology in Workbench

  1. In a new browser tab, login to https://workbench.expel.io/settings/security-devices?setupIntegration=github.

    mceclip2.png
  2. For Where is your device? select Cloud.

  3. Complete these fields using the credentials and information from Step 1:

    • For Name type the name of your GitHub organization.

    • For Location type Cloud.

    • For Organization name type the name of your GitHub organization.

    • For Enterprise slug type the enterprise slug URL. This is only required if you use an enterprise SAML identity provider, otherwise you can leave it blank.

    • For the Application installation ID type the installation ID from Step 1.

  4. Leave the other fields blank.

Tip

This article was accurate at the time of writing, but changes happen. If you find the instructions are outdated, leave a description in the comment field below and let us know!