Integrate the local and remote ServiceNow instances by creating an OAuth API endpoint in the remote ServiceNow instance to authenticate requests.

Before you begin

  • Request Integration Hub subscription.
  • Activate ServiceNow Remote Instance spoke in remote and local ServiceNow instances.
    Note: The terms remote instance and local instance are used in these contexts:
    • Local instance: This is the ServiceNow instance from which the communication is initiated and established.
    • Remote instance: This is the ServiceNow instance with which the local instance communicates.
  • Role required: admin
    Note: Admin role is required to only set up the spoke.

    To use the spoke, ensure that the spoke users have only the required minimum permissions to access data in ServiceNow tables. Do not assign elevated privilege roles to users of this spoke unless very much required. This practice ensures controlled access to data.

    The integration users must have the flow_operator and other required roles to access the table they want to interact with. Also, they need roles to access the Table [sys_db_object] and Dictionary Entry [sys_dictionary] tables to show dynamic options such as, table names and fields in a table.

Register remote ServiceNow instance as an OAuth provider

Register remote ServiceNow instance as an OAuth provider so that the local ServiceNow instance can request OAuth 2.0 tokens.

Before you begin

  • In the remote ServiceNow instance:
    • Create an OAuth API endpoint for external clients. In Redirect URL, specify the URL of the local ServiceNow instance in this format: https://<instance-name>.service-now.com/oauth_redirect.do. For more information, see Create an endpoint for clients to access the instance.
    • Copy and record the values of Client ID and Client Secret.
  • Role required: admin

Procedure

  1. Navigate to All > System OAuth > Application Registry.
  2. Open for the record, RemoteSpoke.
  3. On the form, fill these values.
    Table 1. Application Registries form
    FieldDescription
    Client ID Client ID created in the remote ServiceNow instance.
    Client Secret Client Secret created in the remote ServiceNow instance.
    Authorization URL URL of the remote ServiceNow instance in this format: https://<instance-name>.service-now.com/oauth_auth.do.
    Token URL URL of the remote ServiceNow instance in this format: https://<instance-name>.service-now.com/oauth_token.do.
    Redirect URL URL of the local ServiceNow instance in this format: https://<instance-name>.service-now.com/oauth_redirect.do.
    Default Grant Type Grant type used to establish the token. Select Authorization Code.
    Refresh Token Lifespan Time, in seconds, that the refresh token is valid. The default time is 8,640,0000 seconds.
    PKCE required Option to enable public clients to require PKCE for an authorization.
    Note: You can use only Authorization Code as the Default Grant type when PKCE is enabled.
    Application Application scope that contains this record.
    Accessible from Application scope that this registry is accessible from.
    Active Option to actively use the application registry.
  4. Right-click the form header, and click Save.

Create Credential record for the remote ServiceNow instance

Create credential record for the remote ServiceNow instance. The ServiceNow Remote Instance spoke connection and credential alias uses these credentials to authorize actions.

Before you begin

Role required: admin.
Note: You must perform this task in a local ServiceNow instance.

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.
  4. On the form, fill in the fields.
    FieldValue required
    Name Name to uniquely identify the record. For example, Remote Credentials.
    Active Option to actively use the credential record.
    OAuth Entity Profile OAuth profile created during the registration of the remote ServiceNow instance as an OAuth provider. For example, select RemoteSpoke default_profile.
    Order Order that the credentials are used. For example, enter 100.
  5. Right-click the form header and click Submit.
  6. To generate the OAuth token, click the Get OAuth Token related link.

Create Connection record for the remote ServiceNow instance

Create Connection record for your remote ServiceNow instance. The ServiceNow Remote Instance spoke connection and credential aliases use these connections to perform actions.

Before you begin

Role required: admin.
Note: You must perform this task in a local ServiceNow instance.

Procedure

  1. Navigate to All > Connections & Credentials > Connections & Credentials Aliases.
  2. Open the alias record, ServiceNowRemoteInstance.
  3. From the Connections tab, click New.
  4. On the form, fill in the fields.
    Table 2. HTTP(s) Connection form
    FieldValue required
    Name Name to uniquely identify the record. For example, Remote Connection.
    Credential Credential record created for remote ServiceNow instance. For example, Remote Credentials.
    Connection alias Alias record associated with this connection.
    URL builder
    Note: Do not select the check box.
    Connection URL URL of the remote ServiceNow instance. For example, https://<remote-instance-name>.service-now.com/.
    Active Option to actively use the connection.
    Domain Domain that the action or activity runs in.
  5. Click Submit.

Create Credential record for the local ServiceNow instance

Create credential record for the local ServiceNow instance. The ServiceNow Remote Instance spoke connection and credential alias uses these credentials to authorize actions.

Before you begin

Role required: admin.
Note: You must perform this task in a local ServiceNow instance.

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 Basic Auth Credentials.
  4. On the form, fill in the fields.
    FieldValue required
    Name Name to uniquely identify the record. For example, Local Credentials.
    Username Username to log in to the local ServiceNow instance.
    Password Password to log in to the local ServiceNow instance.
    Active Option to actively use the credential record.
  5. Right-click the form header and click Submit.

Create Connection record for the local ServiceNow instance

Create Connection record for your local ServiceNow instance. The ServiceNow Remote Instance spoke connection and credential aliases use these connections to perform actions.

Before you begin

Role required: admin.
Note: You must perform this task in a local ServiceNow instance.

Procedure

  1. Navigate to All > Connections & Credentials > Connections & Credentials Aliases.
  2. Open the alias record, ServiceNowRemoteInstanceLocalAlias.
  3. From the Connections tab, click New.
  4. On the form, fill in the fields.
    Table 3. HTTP(s) Connection form
    FieldValue required
    Name Name to uniquely identify the record. For example, Local Connection.
    Credential Credential record created for local ServiceNow instance. For example, Local Credentials.
    Connection alias Alias record associated with this connection.
    Connection URL URL of the local ServiceNow instance. For example, https://<local-instance-name>.service-now.com/.
    Active Option to actively use the connection.
    Domain Domain that the action or activity runs in.
  5. Click Submit.