Skip to main content

CollectorsCloud Collectors Administration Guide

Prerequisites to Configure GitHub Cloud Collector

Before you configure the GitHub cloud collector you must complete the following prerequisites.

  • Allow access to your GitHub server addresses over SSL.

  • Ensure that you have the GitHub Enterprise account with an enterprise owner role.

  • Generate a personal access (classic) token for the OAuth2 authentication.

  • Ensure that you have the read:audit_log permission for generating the personal access (classic) token.

Generate the Personal Access Token

To fetch the enterprise audit log entries, following are the required scopes.

  • manage_billing:enterprise Read and write enterprise billing data

  • read:enterprise Read enterprise profile data

For more information, refer to the Personal Access Token related information in the GitHub documentation.

Use the following steps to obtain a personal access token.

  1. Log in to the GitHub enterprise account.

  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 scope or token permission read:audit_log for the connector to retrieve events.

  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 collector configuration.