Skip to content

ServiceNow Query authentication guide

This is a step-by-step guide to acquiring ServiceNow credentials and authorizing the ServiceNow Query component.

Create an OAuth connection

  1. You need to create an OAuth connection. Follow the instructions in OAuth until you reach the Client ID and Client Secret fields—at which point, you should return to this page.
  2. Read the section below to acquire your ServiceNow credentials.
  3. Once you have obtained your ServiceNow credentials, setting the authentication type to OAuth 2.0 Client Credentials in the Add new OAuth wizard will reveal the following fields:
    • Client Id: Copy the Client ID from your new OAuth app.
    • Client secret: Copy the Client Secret from your new OAuth app.
    • Instance: The name of your ServiceNow instance.
    • Username: Your ServiceNow instance username. This is the subdomain of the URL, i.e. subdomain.service-now.com.
    • Password: Your ServiceNow instance password.
  4. Click Authorize.

Acquire ServiceNow credentials

  1. Log in to the ServiceNow Developers portal.
  2. Click your user account icon, displayed as initials in the top right.

  3. The My Instance homepage will be displayed. Click Start Building to open your instance. Copy the Instance URL from your browser. The instance URL will look like the following:

    https://[Instance URL].service-now.com

  4. The browser will redirect you to a login screen for your instance. Enter valid ServiceNow credentials for your instance, and click Log In.

    Note

    Copy the username and password used to log in to the instance, as well as the instance name (the subdomain of the URL, i.e. subdomain.service-now.com). These will be required in the Data Productivity Cloud when you create an OAuth connection to authorize the ServiceNow Query component.

  5. Click the All tab at the top of the page. Use the left-hand menu to scroll down to System OAuth, then click Application Registry.

  6. In the Application Registries page, click New in the top right to create an OAuth app.
  7. You'll be asked What kind of OAuth application? you require. Click Create an OAuth API endpoint for external clients.
  8. A new window will open where you will need to give an appropriate Name for your OAuth app.
  9. Click Submit.
  10. You will be returned to the Application Registries page, where your new OAuth app has been created. Click on the name of your new app.

  11. Click the Toggle Password Visibility button to reveal the client secret.

    Note

    Copy the Client ID and Client Secret. You will need to enter these when you create an OAuth connection in the Data Productivity Cloud.

  12. Select your user account icon, and click Elevate Roles.

  13. The Elevate Role dialog will be displayed. Elevate a role by adding privileges. To do this, tick the available role security_admin. This role will grant modification access to High Security Settings, and allow you to modify the Access Control List.
  14. Click Update.
  15. Click the All tab again at the top of the page, and use the left-hand menu to scroll down to System Security. Click Access Control (ACL), then click New.
  16. In the New record dialog, set the following properties:
    1. "Type" to "record".
    2. "Operation" to "read".
    3. "Name" to "Table [sys_db_object]" in the first drop-down menu. Leave the second drop-down menu set to "-- None --".
    4. In the Requires role section, double-click the text box that says "Insert a new row...", search for and select your desired role. Available roles are activated when you start typing. Click the green tick button to confirm.

  17. Click Submit.

    Note

    Access to the sys_glide_object is required for certain ServiceNow table metadata. You can enable access to this by repeating the above steps, but instead select Field class "[sys_glide_object]" for the ACL's name.

  18. Click the All tab again at the top of the page, and use the left-hand menu to scroll down to User Administration, then click Users.

  19. Click the user you want to modify roles for.
  20. At the bottom of the User page, click the Roles tab, then click Edit.

  21. In the Edit Members page, use the arrows to move your desired roles from the Collection column on the left to the Role List on the right.

    Note

    Access to sys_dictionary is required to retrieve schema information from ServiceNow. You can enable access to this by adding the personalize_dictionary role from the Collection column.

  22. Click Save to confirm the user roles and close the page.

  23. Once you have created an OAuth connection, you can use the ServiceNow Query component.