To setup your GitHub app in Cobalt for OAuth, you will need the following credentials from your GitHub Developer account:

  • Client ID
  • Client Secret
  • Scopes

​
Pre-requisites

  1. GitHub Developer account. You can create one here.
If you haven’t already created an app in GitHub, you’d need to create one.

​
Creating an app in GitHub

To create a GitHub app and aquire the above mentioned credentials, please follow the steps mentioned below:

  1. Log in to your GitHub Developer account.
  2. Click on the Profile icon in the top right, select Settings > Select Developer Settings > Choose OAuth Apps in the left menu.
  1. Go to your Apps catalog in Cobalt > Search for Github > Settings > Use your credentials > Callback Url > Copy it.
  2. Click on New OAuth App button in the right.
  3. Enter the App Name for your application, provide a homepage URL, paste the Callback URL under Authorization callback URL and click on Register application.
  1. Navigate to General in the left menu and copy the Client ID. Click on Generate a new client secret and copy the Client Secret.

​
Configuring credentials in Cobalt

App settings page lets you configure the authentication settings for an OAuth2 based application. For your customers to provide you authorization to access their data, they would first need to install your application. This page lets you set up your application credentials.

Cobalt lets you use pre-configured applications to play around. You can do so by selecting Use our credentials. However, if you wish to use your own application, select Use your own credentials. Provide the aquired Client Id and Client secret and save it.

​
Configuring Scopes

Cobalt lets you configure what permissions to ask from your users while they install your application. The scopes can be added or removed from the App settings page, under Permissions & Scopes section.

For some applications Cobalt sets mandatory scopes which cannot be removed. Additional scopes can be selected from the drop down. Cobalt also has the provision to add any custom scopes supported by the respective platform.

Once the scopes has been added to the application in Cobalt, the app will now request for access of the mentioned scopes.

If you are facing scopes missing or invalid scope error. Make sure you are not passing any custom scope not supported by the platform.

​
Actions and triggers

Once the above setup is completed, you can create orchestrations of your use-cases using GitHub actions and triggers. Following are the set of GitHub actions and triggers supported by Cobalt.

SetupSetup