OAuth 2.0 credentials for GitHub Apps - Authorization Code

Perform the following steps to integrate your GitHub Apps using Authorization code.

Before you begin

Role required:

• oauth_admin in DevOps Change Velocity.
• Admin account in GitHub.

Note: Only user-level repositories are supported. You must have access to all the GitHub repositories that you want to configure in DevOps Change Velocity using Authorization code.

The OAuth Authorization Code grant type is supported for GitHub & GitHub Enterprise with MID server.

Configure the GitHub App in your GitHub account (Authorization Code)

Create a custom GitHub App from your GitHub account to enable OAuth 2.0 authentication with your ServiceNow instance.

Before you begin

GitHub requirement: GitHub App configured to integrate with ServiceNow

Role required: No instance role required

About this task

Complete these steps from your GitHub account. See Building GitHub Apps on the GitHub Developer site for instructions on creating and configuring custom applications.

Procedure

1. From your GitHub account, create your GitHub App by navigating to Developer Settings > GitHub Apps.

2. In the Homepage URL field, enter https://<instance-name>.service-now.com.

3. In the User authorization callback URL field, enter https://<instance-name>.service-now.com/oauth_redirect.do.

4. In the Identifying and authorizing users section, deselect the Expire user authorization tokens field.

5. In the Webhook section, deselect the Active field.

6. Leave the remaining fields empty (default).

7. In the Repository permissions section, configure these settings.

1. Leave the remaining permissions as No access (default).

2. Install the newly created GitHub App on the accounts of your choice.

Register GitHub as an OAuth Provider (Authorization Code)

Use the information generated during GitHub App account configuration to register GitHub as an OAuth provider and allow the instance to request OAuth 2.0 tokens.

Before you begin

Role required: admin, sn_devops.admin

Procedure

1. Navigate to All > System OAuth > Application Registry.

2. Click New.

   The system displays the message What kind of OAuth application?

3. Select Connect to a third party OAuth Provider.

   The system displays an empty Application Registries form.

4. Complete the form.

1. Leave the rest of the form fields as default.

1. Right-click the form header, and click Save.

   • The system validates the OAuth credentials and populates the Redirect URL (Hint: It should match the User authorization callback URL previously provided in your GitHub App configuration).
   • The system populates OAuth Entity Profile with Grant Type as Authorization Code. For example, OAuth Entity Profile is created with default Name, My GitHub App Provider default_profile

Create a credential record for GitHub App provider (Authorization Code)

Create a credential record to the GitHub App provider previously created to authorize actions.

Before you begin

Role required: admin, credential_admin

Procedure

1. Navigate to All > Connections & Credentials > Credentials.

2. Click New.

   The system displays the message What type of Credentials would you like to create?.

3. Select OAuth 2.0 Credentials.

   The pop-up window displays an empty OAuth 2.0 Credentials form.

4. Fill in these values.

1. Save the record.

2. Click the Get OAuth Token related link to generate the OAuth token.

Related topics

GitHub Actions configurations

ServiceNow DevOps custom actions from GitHub marketplace