Prepare for a GitHub Connection (Beta)

To set up your GitHub repository with Data 360, you need to provide some details. Gather this information before you get started.

Select a method for authentication:

  • Personal Access, which requires a GitHub Personal Access Token and a URL
  • OAuth App, which requires a OAuth Client ID and Secret, a GitHub Personal Access Token, and an API URL.

In GitHub, follow these instructions to generate a Classic Personal Access Token. You must use a GitHub account that has read and write access to the repository you want to use for connecting to Data 360. Ask your GitHub repository maintainer for help if required. Keep in mind:

  • When creating the token, set the expiration date to never expire.
  • When the token appears in the GitHub UI, click the copy button and save this token in a safe location. You need it later.

After generating the token, you can’t see it again. Save it in a secure location. If you need to regenerate the token, you must reconfigure the connector with the new token information. Otherwise, the connector breaks.

Copy the full URL to your repository, for example, https://api.github.com for GitHub.com or https://github.enterprise.com/api/v3 for GitHub Enterprise. Your actual URL can differ depending on your Domain Name System (DNS). Once you’ve located the URL, proceed to Repository ID.

This procedure requires you to register an OAuth app under your organization.

See the GitHub documentation for details. As part of the process you will be shown a Client ID and a Client Secret. Make sure to copy and save the Client Secret when it displays. You cannot view it again after you close the window.

In GitHub, follow these instructions to generate a Personal Access Token. You must use a GitHub account that has read and write access to the repository you want to use for connecting to Data 360. If your integration uses the OAuth flow to Log in with GitHub, it may generate a token for you after you click Save. If it asks for a token, create a Fine-grained token or Classic token with the repo and read:user scopes.

Ask your GitHub repository maintainer for help if required.

Keep in mind:

  • When creating the token, set the expiration date to never expire. Otherwise, you have to regenerate the token and create a new connector each time the token expires.
  • When the token appears in the GitHub UI, click the copy button and save this token in a safe location. You need it later.

After generating the token, you can’t see it again. Save it in a secure location. If you need to regenerate the token, you must reconfigure the connector with the new token information. Otherwise, the connector breaks.

To locate your OAuth Client ID:

  1. From GitHub, click your user avatar.
  2. Go to Settings > Developer settings > OAuth Apps.
  3. Click on the specific application name for which you need the Client ID.
  4. The application's settings page opens, displaying your Client ID next to a label of the same name. The Client ID is a public identifier and is always visible.

When the Client secret is generated it displays only once. If you don't have your client secret, use this procedure to generate a new one.

To regenerate an OAuth Client secret:

  1. From your GitHub repository screen, click your user avatar.
  2. Go to Settings > Developer settings > OAuth Apps.
  3. Click on the specific application name for which you need the client secret.
  4. On the page, go to Client secrets and click the button to Generate a new client secret.
  5. Confirm, if prompted.
  6. The new secret displays. Copy and save the new secret in a secure location, as you won't be able to view it again after you leave the page.

After you locate the URL, proceed to Repository ID. The API URL tells Data 360 where to send requests.

  • Standard GitHub: Use https://api.github.com.
  • GitHub Enterprise: The URL format is similar to: https://[hostname]/api/v3.

To learn more, read the GitHub documentation on GitHub REST API Endpoints.

In the address bar for your repository, the repository ID appears after your username, for example, https://github.com/GHUser/RepoID. Copy both the GHUser and RepoID. For example: GHUser/RepoID.

Alternatively, using the GraphQL API Explorer, run this command. Replace the owner and repo_name with the actual information: gh api graphql -f query='query{repository(owner: "owner", name: "repo_name"){id}}'

Use labels to classify and filter your content. When your GitHub connector runs, only specified items are ingested into Data 360. Read more about Managing labels.