Connect to a Git provider using OAuth 2.0

Set up an OAuth 2.0 application registry and credentials to connect to your Git provider from ServiceNow Studio.

Configure an OAuth 2.0 application registry for ServiceNow Studio

Configure how the client ID and secret are sent to the OAuth 2.0 provider associated with your Git provider.

Before you begin

Create an OAuth application with your Git provider and configure it to redirect to your instance. In this OAuth application, use your instance URL as the homepage URL and https://<instance>/oauth_redirect.do for the authorization callback URL. GitHub, GitLab, Bitbucket, and Azure Repos are supported by default.

Role required: admin

Important:

For Azure Repos, the maximum length of the Client Secret field must be updated to 2048 before you add the secret.

1. Navigate to All > System Definition > Tables.
2. Filter the table by entering oauth_entity for the Name field.
3. Select the Application Registries [oauth_entity] table.
4. In the Columns related list, locate the Client Secret column and enter 2048 as the value of its Max length attribute.
5. Select Update.

About this task

To use OAuth 2.0 authentication with ServiceNow Studio, you must register the OAuth application you created from your Git provider. Follow this procedure to configure an OAuth application registry [oauth_entity] on your instance.

Procedure

1. Navigate to All > System OAuth > Application Registry.
2. Select New.
3. On the interceptor page, select Connect to a third-party OAuth provider.
4. On the form, fill in the fields.

   For additional information about fields on the form, see Connect to a third-party OAuth provider.

   Table 1. Application Registries form

   Field	Description
   Name	Unique name for the third-party OAuth connection.
   Client ID	Client ID of the OAuth application in your Git provider.
   Client Secret	Client secret of the OAuth application in your Git provider.
   OAuth API Script	Script used to customize request and response to the external OAuth provider. Select one of the following depending on your Git provider: GitHub: OauthAPIScriptForGitHub GitLab: OauthAPIScriptForGitLab Bitbucket: OauthAPIScriptForBitbucket Azure Repos: OauthAPIScriptForAzureRepos Note: To use other Git providers, you can use these scripts as examples to create your own OAuth API script for your OAuth provider. The name of the script must begin with “Oauth”.
   Default Grant type	Default grant type used to establish the token. Select Authorization code. An authorization code is granted to the client to obtain an access token, which is then used to obtain access to the resource.
   Refresh Token Lifespan	Time, in seconds, that the refresh token is valid.
   Application	Application scope that contains this record.
   Accessible from	Option to make the application registry accessible from all application scopes or from this scope only.
   Active	Option for turning the OAuth application on or off.
   Authorization URL	OAuth authorization code endpoint for your Git domain. For example: GitHub: https://github.com/login/oauth/authorize GitLab: https://gitlab.com/oauth/authorize Bitbucket: https://bitbucket.org/site/oauth2/authorize Azure Repos: https://app.vssps.visualstudio.com/oauth2/authorize
   Token URL	OAuth server token endpoint for your Git domain. For example: GitHub: https://github.com/login/oauth/access_token GitLab: https://gitlab.com/oauth/token Bitbucket: https://bitbucket.org/site/oauth2/access_token Azure Repos: https://app.vssps.visualstudio.com/oauth2/token
   Redirect URL	OAuth callback endpoint. If empty, the instance auto-generates a value of https://<instance>/oauth_redirect.do.
   Use mutual authentication	Option to use mutual authentication. Leave this option cleared to turn off using mutual authentication for token request and revocation.
   Send Credentials	Method in which the OAuth client populates the client credentials in the request. For GitHub, GitLab, or Bitbucket, select As Basic Authorization header. For Azure Repos, select In Request Body (Form URL-Encoded).

5. Select Submit.

What to do next

Configure OAuth 2.0 credentials to connect to a Git provider

Configure OAuth 2.0 credentials to connect to a Git provider

Connect to a Git domain or repository using OAuth 2.0 credentials to manage applications in source control from the ServiceNow Studio.

Before you begin

• An administrator must configure how the client ID and secret are sent to the OAuth 2.0 provider associated with your Git provider. For more information, see Configure an OAuth 2.0 application registry for ServiceNow Studio.
• Create a dedicated Git repository for an application in a Git provider such as GitHub, GitLab, Bitbucket, or Azure Repos.

Role required: admin

Procedure

1. Navigate to All > App Engine > ServiceNow Studio.
2. Use one of the following keyboard shortcuts to open the command palette:
   • Windows: Ctrl-Shift-P
   • Mac: Cmd-Shift-P
3. Enter Git: Set IDE Git credentials and press Enter.
4. From the New Git credential form, select OAuth.
5. On the form, fill in the fields.

   Table 2. New Git credential form

   Field	Description
   Git repository URL	HTTPS URL of a Git repository associated with your Git credentials.
   Git username	Git username.
   Select an OAuth profile	OAuth 2.0 credentials from your Git provider. The OAuth profile is created with the application registry, which must be configured by an administrator.
   Use this credential for all repositories	Option to use the credentials for all repositories in the Git domain associated with the Git repository URL.

6. Select Submit.

   The first time you use a Git command, you're prompted to authorize your user from the Git provider.

Result

Your Git credentials are associated with your user on the instance and used for all repositories in the domain from the Git repository URL. If you add different credentials for a repository in the same domain, the new credentials are used and the previous credentials are set to inactive.

What to do next

After initializing or cloning a repository, you can begin using source control. For more information, see Using Fluent source control in ServiceNow Studio.

To manage existing Git credentials, use the Git: Manage Git credentials command from the command palette.