When integrating a new application with your BetterCloud instance, the overall installation process is consistent. However, each integration is different, and may require varying levels and types of authentication. This article provides instructions for configuring and collecting all the information you need in order to add the GitHub integration in BetterCloud.
BetterCloud requires the following authentication type when integrating with GitHub:
- API Token (githubAccessToken)
Please Note the following important requirements:
Domains on any paid GitHub Team plan may generate an API token and integrate with BetterCloud. However, only domains with an Enterprise GitHub subscription will have the necessary permissions to run the following actions in BetterCloud:
- Add User to Team
- Remove User From Team
See more about GitHub's pricing here.
Additionally, GitHub organizations that are SAML-enabled will need to authorize their personal access token for use with SAML SSO before taking action in BetterCloud using that token. This process is fairly straightforward, and can be carried out using the steps in this article.
In order to generate an access token with necessary permissions, a user must have admin access to your GitHub instance. Follow the steps below to generate and retrieve your token in GitHub:
Under the account dropdown in the top right corner of the page, select “Settings.”
Navigate to “Developer settings.”
In the developer settings, click on the “Personal access tokens” section, and generate a new token.
You will need to name your token and select the scopes it includes. It is recommended to set these scopes as broadly as possible, otherwise some actions may fail due to insufficient scopes.
Once you create your token, it will be presented for you to copy. Be sure to copy it now, as your token will not be viewable again.
Copy the token into both the "API Token" field, and the "githubAccessToken" field when adding the integration.
Once you have successfully added the integration, your API token can be updated at any time from your integration’s configuration.