GitHub

Overview

This source connector fetches from the GitHub REST API.

Data Source	Stream Name
organization audit log	`organization_auditlog`

The following authentication options are supported by this connector:

Authentication Method	Supported	Documentation
Personal access token(s)	yes	Managing your personal access tokens
GitHub App authentication	yes	GitHub App installation

Multiple personal access tokens can be used to load balance your API consumption.

Create a Personal access token (classic)
1. Expiration: No expiration
2. Scopes:
  1. read:audit_log

Field	Required	Description
Personal access token(s)	yes	Comma separated list of personal access tokens. Multiple tokens can be used to load balance your API quota consumption.

Register a GitHub App for your organization.
1. Homepage URL
  1. https://docs.tarsal.cloud/docs/source-github
2. Webhook
  1. Deselect the Active checkbox
3. Permissions
  1. Organization permissions: Read-only
  2. All other permissions should be set to No access
Once created, copy the Client ID to be used in the Tarsal configuration later.
Generate a private key
1. Under the General sub navigation for the App, click the Generate private key button. This will download a certificate file named something like app-name-date.private-key.pem. Save this file as it will be used in the Tarsal configuration later.
Install the App
1. Back at the top in the left navigation, click Install App and then click the Install button
After clicking install you will be navigated to a website with a link that looks like this: https://github.com/settings/installations/{installation_id} Copy the installation_id from the path in the URL to be used in the Tarsal Configuration later
1. You can find the installation_id later by navigation to Profile > Settings > Integrations > Applications and clicking Configure on the App

Field	Required	Description
Client ID	yes	The GitHub App Client ID
Installation ID	yes	The ID corresponding to the specific installation of your application. Different from the client ID from and can be found in the URL of the app installation.
Private Key	yes	The GitHub App private key. Found in the `*.private-key.pem` file downloaded during the app creation process.

Field	Required	Description	Example
Organization/Repositories	yes	Space separated list of `organization/repository`. Examples: All repositories: `tarsalhq/*` Single repository: `tarsalhq/repo1` Multiple repositories: `tarsalhq/repo1 tarsalhq/repo2`	`tarsalhq/*`
Authentication	yes	Choose one of the two methods listed in the authentication section above

The source IP address for events, used to populate the tarsal normalized fieldt_ip_address, is only available to enterprise customers.