Skip to main content

Cloud ConnectorsExabeam Cloud Connectors Configuration Guide

GitHub Cloud Connector

GitHub is a version control and collaboration platform that offers version control and source code management for developers to host, build software, review code, share, and manage projects. For more information visit their website.

Prerequisites to Configure the GitHub Connector

Before you configure the GitHub connector to monitor your enterprise GitHub server or cloud-based GitHub service, you must complete the following prerequisites:

  • Allow access to your GitHub server addresses over SSL

  • Generate a personal access token for the OAuth2 authentication method

Generate the Personal Access Token

To obtain a personal access token:

  1. Log in to GitHub.

  2. On your profile page, in the upper right corner, click the profile image, then click Settings.

  3. In the left pane, navigate to Personal Settings > Developer Settings, then click Personal access tokens.

  4. In the New personal access token section, assign the following token permissions for the connector to retrieve events:

    1. repo – Select all the check boxes.

    2. admin:org – Select the read:org check box.

    3. user – Select the read:user check box.

  5. Click Generate new token.

  6. Copy the token, represented by a string of letters and numbers. Use this token to access GitHub API to complete the GitHub connector configuration.

Configure the GitHub Connector

GitHub is a version control and collaboration platform that offers version control and source code management for developers to host, build software, review code, share, and manage projects. For more information visit their website.

The following table displays audit source API and security events supported by the connector.

Audit Source: API

Service or Module Covered

Event Types

Event Included

Repository events

Use the GitHub timeline API

Any

Events supported by GitHub timeline APIs

All GitHub event types and push to repository

For more information about events supported by timeline API, see

https://docs.github.com/en/rest/reference/activity

The following types of repositories can be discovered by GitHub API:

  • Public repositories owned by an organization

  • Private repositories owned by an organization

  • Public repositories owned by an individual

Private repositories owned by an individual cannot be discovered by the GitHub API.

Table 14. Audit source API and security events supported by the connector


To configure the GitHub connector to import data into Exabeam Cloud Connector platform:

  1. Complete the Prerequisites to Configure the GitHub Connector.

  2. Log in to the Exabeam Cloud Connectors platform with your registered credentials.

  3. Navigate to Settings > Accounts > Add Account.

  4. Click Select Service to Add, then select GitHub from the list.

  5. In the Accounts section, enter the required information. Required fields are indicated with red bar.

    1. Tenant – Select a tenant to attach to the connector if you are using the multi-tenant edition. Otherwise, select default.

    2. Account Name – Specify a name for the GitHub connector. For example, GitHub_sourcecontrol.

    3. (Optional) Description – Describe the GitHub connector. For example, GitHub cloud service for corporate source control.

    4. Authentication Method – Select oauth2 from the list.

    5. Personal Token: Enter the personal access token that you obtained while completing prerequisites.

    6. Host Name – Enter the GitHub server host name.

      Note

      If you use enterprise GitHub server, enter GitHub server address. For example, mygithub.myorg.com If you use cloud based GitHub service, enter github.com.

  6. To confirm that the Exabeam Cloud Connector platform communicates with the service, click Test Connection.

  7. Click Done to save your changes. The cloud connector is now set up on the Exabeam Cloud Connector platform.

  8. To ensure that the connector is ready to send and collect data, Start the connector and check that the status shows OK.