For the complete documentation index, see llms.txt. This page is also available as Markdown.

ServiceNow

1 Connecting to ServiceNow

Before you can connect to data, you will need to ensure the authenticating user has the following permissions assigned at minimum, required for listing metadata. Before you can do this, the administrator of the account must elevate their role by navigating to User menu -> Elevate Roles -> check the security_admin box -> OK. For the tables listed below, the user must have both row-level permission, such as sys_db_object, as well as field-level permission, such as sys_db_object.*. For additional tables which the user wishes to access, they must have at least row-level permission.

The connection property Url is a required property on all connections.

1.1 READ sys_db_object

Access to sys_db_object is required to connect to data. You can enable access to this as follows:

  1. Navigate to the System Security -> Access Controls (ACL). Select New to create an access control object.

  2. For Type, select record.

  3. For Operation, select read.

  4. For Name, select Table [sys_db_object] in the first drop-down and --None-- in the second drop-down.

  5. In the Requires role section, double-click the text box that says Insert a new row.... Search for and select your desired role.

  6. Click Submit to create the ACL object.

  7. Assign the role which has the created ACL to the authenticating user. To do this, navigate to User Administration -> Users -> Select authenticating user -> Roles -> Edit... -> add your role from collection.

1.2 READ sys_glide_object

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

1.3 READ sys_dictionary

Access to sys_dictionary is required to retrieve schema information from ServiceNow. You can enable access to this by navigating to User Administration -> Users -> Select authenticating user -> Roles -> Edit... -> add "personalize_dictionary" role from collection.

2 Authenticating to ServiceNow

Connects to ServiceNow via the Table, Attachment, Aggregate, Service Catalog, and Import Set APIs. Walks the full table inheritance chain to surface inherited fields.

Connection Properties

Property

Key (conn string)

Required?

Description

Instance

Instance

Yes

ServiceNow instance name, e.g. mycompany (resolves to mycompany.service-now.com) — or full URL.

User

User

Yes

ServiceNow username.

Password

UserPassword

Yes

ServiceNow password.

Auth Scheme

AuthScheme

No

Basic (default) or OAuth.

OAuth Client Id

OAuthClientId

No

Required if AuthScheme=OAuth.

OAuth Client Secret

OAuthClientSecret

No

Required if AuthScheme=OAuth.

OAuth Refresh Token

OAuthRefreshToken

No

Required if AuthScheme=OAuth.

Minimum Connection String (Basic Auth)

Instance=mycompany;User=admin;UserPassword=secret

Last updated