GitHub Cloud

Supported version:  Cloud(latest)

API Rate Limit:

1. 15000 requests per hour for OAuth2.0 

2.  5000 requests per hour for Personal Access Token

Supported Authentication: Token-based authentication and OAuth 2.0 authentication

IMPORTANT: Please make sure your GitHub instance must be accessible from the Gathr Machine.

 

Token-based authentication

To configure GitHub Cloud Connector using token based authentication-:

Steps to generate token from GitHub UI

1. Open GitHub in your browser
2. Go to the top-right corner of your screen and click on “Settings”

Note : You must have necessary rights in the native tool to perform this action.

3. Click on Developer Settings -> Generate New Token and add the following details and select all scopes.

     

4. Now, go to Gathr UI in your data source configuration, and add following details:

1. Enter GitHub Cloud URL : https://api.github.com
2. Select Authentication Type as Token
3. Select “Create New Account” and add account name
4. Check “Pass Parameters(s) in Header” and add below details:
   • Key : Authorization
   • Value : Bearer<SPACE><Token Generated from GitHub>
5. Click on “Save”

Authorizing a personal access token for use with SAML single sign-on

Note:- To use a personal access token with an organization that uses SAML single sign-on (SSO), you must first authorize the token.

How to create a new personal access token and then authorize it.

1. In the upper-right corner of any page In GitHub, click your profile photo, then click Settings.

     

 2. In the left sidebar, click Developer settings.

 3. In the left sidebar, click Personal access tokens.                                                                                                                                                                                                        

4. Next to the token you would like to authorize, click Configure SSO.

      

5. To the right of the organization you'd like to authorize the token for, click Authorize.

      

         

OAuth 2.0 Authentication

To configure GitHub Cloud Connector using OAuth 2.0 authentication-:

Steps to generate token from GitHub UI

1. Open GitHub in your browser.
2. Go to the top-right corner of your screen and click on “Settings”.

Note : You must have necessary rights in the native tool to perform this action.

 

 3. Go to Developer Settings in your GitHub account.

 

        

    4.  Create a New GitHub App: Select GitHub Apps -> New GitHub App, and fill in the required details.

 

        

   5. Get Your OAuth 2.0 Credentials: Fill in the required details, click "Create GitHub App", and                         obtain the Client ID and Client Secret. Add additional details as needed and ensure these                               credentials are kept secure.

 

       

 

Steps to configure the connection of the connector:

 

Right-click on Connector >> Connections >> Configure.

Enter the following details in the form:
     
     a. Instance URL: https://api.github.com
     b. Enter Application Key: Client ID provided by GitHub.
     c. Enter Application Secret: Client Secret provided by GitHub.
     d. Authorization URL: https://github.com/login/oauth/authorize
     e. Access Token URL: https://github.com/login/oauth/access_token
     f. Domain for Callback Authentication: Ensure the hostname matches the domain name and specify the callback URL.

    g. In the "Additional authorization parameters" section, enter Accept as the Key and                                  application/json as the Value.
     h. Click on ‘Save’.
     i. On clicking ‘Save’, a pop-up will appear which requires GitHub user to login using the credentials              and choose ‘Allow access’ if asked in the pop-up window. 

                     

Important: Please make sure, the pop-up is not blocked by the browser.