Setting up GitLab OAuth 2.0 credentials for DevOps
Integrate your GitLab account with your ServiceNow instance by creating a custom OAuth application in GitLab and authenticating requests from ServiceNow DevOps.
Configure your GitLab account, register GitLab in the application registry, and create a credential record for the GitLab App provider.
Role required: oauth_admin.
Parent Topic:GitLab integration with DevOps Change Velocity
Configure the GitLab App in your GitLab account (Authorization Code)
Create a custom GitLab App from your GitLab account to enable OAuth 2.0 authentication with your ServiceNow instance.
Before you begin
Role required: admin
About this task
Configure GitLab as an OAuth 2.0 authentication identity provider. For more information, see GitLab documentation.
Procedure
From your GitLab account, create your App by navigating to Edit Profile > Applications.
In the Add new application form, specify a Name, and in Redirect URI field, enter
https://<instance-name>.service-now.com/oauth_redirect.do.In the Scopes section, ensure that you select the api check box.
Leave the remaining fields empty (default).
Click Save application.
The application is created. You can open the application to access the Application ID, Secret key, and Callback URL.
Install the newly created GitLab App on the accounts of your choice.
Register GitLab as an OAuth Provider (Authorization Code)
Use the information generated during GitLab App account configuration to register GitLab as an OAuth provider and allow the instance to request OAuth 2.0 tokens.
Before you begin
Role required: admin
Procedure
Navigate to System OAuth > Application Registry.
Click New.
The system displays the message What kind of OAuth application?
Select Connect to a third party OAuth Provider.
The system displays an empty Application Registries form.
Complete the form.
| Field | Value required |
|---|---|
| Name | Enter any name to uniquely identify the record. For example, enter `My GitLab App Provider`. |
| Client ID | Enter the Application ID of your GitLab App. |
| Client Secret | Enter the secret key of your GitLab App. |
| OAuth API script | Select OAuthDevOpsGitLabHandler. |
| Default Grant type | Select Authorization Code. |
| Authorization URL | Enter `https://gitlab.com/oauth/authorize`. For an on-premise deployment, use the proper GitLab host URL. |
| Token URL | Enter `https://gitlab.com/oauth/token`. For an on-premise deployment, use the proper GitLab host URL. |
Leave the rest of the form fields as default.
Right-click the form header, and click Save.
- The system validates the OAuth credentials and populates the Redirect URL (Hint: It should match the Redirect URI value previously provided in your GitLab 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 GitLab App Provider default_profile.
- Validate that the OAuth Entity Scopes related list contains the api scope.
Create a credential record for GitLab App provider (Authorization Code)
Create a credential record for the GitLab App provider previously created to authorize actions.
Before you begin
Role required: admin
Note: The user who creates the credential record, and generates the OAuth token in ServiceNow must have at least the Maintainer role in GitLab for project webhooks, and Owner role for group webhooks to ensure that webhooks can be auto-configured. For more information, see GitLab documentation.
Procedure
Navigate to Connections & Credentials > Credentials.
Click New.
The system displays the message What type of Credentials would you like to create?.
Select OAuth 2.0 Credentials.
The pop-up window displays an empty OAuth 2.0 Credentials form.
Fill in these values.
Field Value required Name Enter any name to uniquely identify the record. For example, enter My GitLab App Credential.Active Enable OAuth Entity Profile Select the default OAuth Entity profile you created previously. Applies to Select the MID Servers that can use this credential. For example, select All MID Servers. Order Select the order to apply this credential. For example, enter 100.Save the record.
Click the Get OAuth Token related link to generate the OAuth token.
A successful token generation indicates that you can now authenticate connection between ServiceNow DevOps and GitLab via OAuth.