GitHub Enterprise Cloud Audit

GitHub Enterprise helps businesses of all sizes manage their software development and delivery. It increases productivity, automates processes, and keeps code secure. For detailed information, please refer to the GitHub Enterprise’s official documentation.

Integration Method: API

Tables: API Activity (6003)

This integration supports the following events.

This integration supports the following versions.

Prerequisites

• The user should have access to the GitHub Enterprise platform with admin privileges.

• The user should have access to DataBee console.

Configuration Overview

1. Generate Personal Access Token (Classic) from GitHub Enterprise platform to access the APIs with Enterprise Admin account.

2. Add the GitHub Enterprise Cloud Audit data feed in the DataBee console with the below parameters

   DataBee Parameter	GitHub Enterprise Cloud Audit Parameter
   Token	Personal Access Token (Classic)
   Enterprise Name	Enterprise Name

GitHub Enterprise Cloud Audit Configuration

Generate Personal Access Token (Classic)

1. Sign in to the GitHub Enterprise platform.
    
   

2. Navigate to your profile on the top right corner.

   

3. Click on Settings.

    
   

4. In the left sidebar, click Developer settings.
    

5. In the left sidebar, under Personal access tokens, click Tokens (classic).

   
   
   

6. Select Generate new token, then click Generate new token (classic).

   
   
   

7. Enter the following details to generate a new Personal Access Token (Classic).

   • Note: give your token a descriptive name.

   • Expiration: select No expiration.

   • Select Scopes: add read:audit_log.

   

   
    

8. Click on Generate token.
    
   

9. Now Copy the generated Personal Access Token (Classic) and save it at a safe location for later use.
    
   

   Note:

   Store the generated Personal Access Token in a secure location, as it will be visible only once.

Get Enterprise Name

1. Navigate to your profile on the top right corner.
    

2. Click on Your enterprises.
    
   

3. From the list of enterprises, copy the name of the enterprise relevant for the DataBee integration.

   
   
   

DataBee Configuration

1. Login to the DataBee UI, navigate to Data > Data Feeds and click the Add New Data Feed button.
    
   

2. Search for the GitHub Enterprise Cloud Audit and click it as shown below.
    
   

3. Click on the API Ingest option for collection method.
    
   

4. Enter feed contact information and click Next.
    
   

5. In the configuration page, confirm the following:

   • Authorization Method: Bearer Token

   • API Base URL: this is the base URL that DataBee will interact with.

   • Token: enter the above generated Personal Access Token (Classic).

   • Enterprise Name: enter Enterprise Name generated in previous steps.

   • Event Types: preselected for all the event types that integration pulls.

   

6. Click Submit.

Troubleshooting Tips

• Ensure Personal Access Token (Classic) pasted correctly. If a Personal Access Token is lost, navigate and try to regenerate the token. Ensure no spaces or unexpected characters are included and reconfigure the DataBee feed.

• Ensure read:audit_log permission is provided as Scope while generating Personal Access Token (Classic).