Set up GitLab spoke

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 2 minutes to read
  • Integrate your ServiceNow instance and the GitLab by creating a custom OAuth application in the GitLab.

    Before you begin

    Add GitLab token

    Add GitLab token to authenticate requests from your ServiceNow instance.

    Before you begin

    Role required: admin.

    Procedure

    1. Navigate to All > GitLab Token Management > GitLab Token Managements.
    2. Click New.
    3. On the form, fill these values.
      Table 1. Gitlab Token Management form
      Field Description
      Secret Secret created during the GitLab application configuration.
      Name Name to identify the record.
      OAuth Entity Profile Leave the field empty. System auto-assigns the default entity profile after the connection is configured.
    4. Right-click the form header and click Save.
    5. Click Generate Secure Token.
      Value of the generated secure token is displayed.
    6. Copy and record the value of the secure token for later use.
    7. Click Update.

    Create OAuth application in GitLab account

    Create a custom OAuth application from your GitLab account to enable OAuth 2.0 authentication with the GitLab spoke.

    Before you begin

    • GitLab account
    • Role required: GitLab admin.

    About this task

    Complete these steps from your GitLab account. See the GitLab documentation for instructions on creating and configuring applications.

    Procedure

    1. From your GitLab account, create an application.
    2. Enter ServiceNow instance URL in Redirect URI.
      The format of the redirect URL is: https://<instance-name>.service-now.com/api/sn_gitlab_spoke/gitlab_oauth_redirect/oauth?secureToken=<Secure-Token>.

      Replace <Instance-Name> with the name of your ServiceNow instance and replace <Secure-Token> with the secure token you had generated in the ServiceNow instance.

    3. Copy and record the Application Id and Secret for later use.
      These details are required to register the application as a third-party OAuth provider on your ServiceNow instance.

    Result

    The custom OAuth application from your GitLab account is created and can be integrated with the ServiceNow instance.

    Configure a connection for the GitLab spoke

    Add and configure a GitLab connection to authenticate ServiceNow requests in GitLab spoke.

    Before you begin

    Role required: admin

    Procedure

    1. Navigate to All > Process Automation > Workflow Studio.
    2. Click the Integrations tab.
    3. Under Connections, the Outbound connections are displayed by default.
    4. Locate the GitLab connection alias and click View Details.
    5. Click Edit or if you are configuring the spoke for the first time, click Configure.
    6. On the Connection form, fill in the fields.
      Field Description
      Connection Name Name to uniquely identify the connection.
      Connection URL Enter https://gitlab.com/api.
      Note:
      If you have installed GitLab on an on-premise server, enter the URL in this format: https://<gitlab-hosted-instance>.com/api
      OAuth Entity Name Name to identify the OAuth entity record.
      OAuth Client ID Application ID created during the GitLab application configuration.
      OAuth Client Secret Secret created during the GitLab application configuration.
      OAuth Redirect URL OAuth callback endpoint. The format of the redirect URL is: https://<instance-name>.service-now.com/api/sn_gitlab_spoke/gitlab_oauth_redirect/oauth?secureToken=<Secure-Token>.

      Replace <Instance-Name> with the name of your ServiceNow instance and replace <Secure-Token> with the secure token you had generated in the ServiceNow instance.

    7. Click Configure and Get OAuth Token.