ServiceNow Users

ServiceNow user records establish a relationship between an individual and your ServiceNow instance. User records consist of a user name, a password, and information relating to the individual, such as contact information, location, and job title. For detailed information refer to the ServiceNow’s official documentation.

Integration Method: API

Tables:  User Inventory (5003)

This integration supports the following events.

This integration supports the following versions.

Prerequisites

• ServiceNow Admin privileges to create an OAuth API endpoint for external clients.

• Access to the DataBee console.

Configuration Overview

1. Generate API credentials on the ServiceNow console with the required user roles.

   1. Create OAuth client application

   2. Create user

   3. Assign roles to user

2. Add the ServiceNow Users Data Feed integration in the DataBee console with the required API credentials.

   DataBee Parameter	ServiceNow Parameter
   Client Key	Client ID
   Client Secret	Client Secret
   Username	User ID
   Password	Password
   Token URL:<instance>	ServiceNow Instance
   API URL :<instance>	ServiceNow Instance

ServiceNow Configuration

The scope is a mechanism to limit application access to ServiceNow data. ServiceNow platform supports authentication scopes to allow admins to limit access of an OAuth client application to a specific REST API.

Create OAuth client application

1. Get the ServiceNow instance from the URL as highlighted below.
    

2. Navigate to All

   1. In the search bar, enter System OAuth.

   2. Navigate to System OAuth > Application Registry.
       

3. Click on the New button.

    

4. Click the New Inbound Integration Experience.
    

5. Click the New Integration button.

   

6. Click the OAuth – Resource owner password credential grant.

   

7. Fill in the required details in the form:

   1. Name: Enter a unique name for OAuth client application.

   2. Client ID: Automatically generated by the ServiceNow OAuth server.

   3. Client Secret: Enter Client secret for the Oauth application or leave empty for auto generation.

8. Copy the Client ID for later use.

9. Click on the Save button.

   

10. Click Skip for now in the dialogue box.

     

11. Select the Application created in the previous step from the Application Registries table.
     

12. Click on Lock icon and save the Client Secret for later use. Also make sure the Scope Restriction is set to Broadly scoped.
     

    Name	Unique Name that identifies the application
    Client ID	This will be auto generated by the instance: To be provided to DataBee.
    Client Secret	This will be auto generated by the instance Or Can Entered: To be provided to DataBee.
    Refresh Token Lifespan	8,640,000 seconds (100 days) & can be increased
    Access Token Lifespan	1800 seconds (30 Minutes) & can be increased

Create User

1. Navigate to All,

   1. In the search bar, enter User Administration.

   2. Navigate to User Administration > Users.
       

2. Click on the New button. The Create User form window will appear.
    

3. Fill in the required fields to create a user:

   • User ID: Enter a unique username.

   • First Name: Enter the user's first name.

   • Last Name: Enter the user's last name.

   • Time Zone: Set to GMT/UTC to ensure the API response includes GMT/UTC dates.

   • Date Format: Set to System (yyyy-MM-dd).

   • Active: Ensure the checkbox is selected.

   • Locked Out: Ensure the checkbox is not selected.

   The user must be active and not locked out to allow the instance to generate an access token for OAuth.

4. Copy the User ID for later use.

5. Click the Submit button.

   
   

6. Search for the User ID created in the previous step and click on it.
    

7. Click on the Set Password button.
    

8. Click on the Generate button and copy the password for later use.

   1. Click on the Save Password button.

   2. Click on the Close button.
       

Assign roles to user

1. Go to Roles tab and click on Edit to assign roles to user.
    

2. In the search bar:

   1. Enter "user_admin" or "itil" and click Add.

      Note:

      The created user must be an allowed member to fetch a user record when the user_admin role is assigned. Additionally, if you select the itil role while adding a role, the following fields will be missing in the API response.

      Event Type	Missing Fields
      Users	locked_out, password_needs_reset

3. Click the Save button.

   

DataBee Configuration

1. Login to the DataBee UI, navigate to Data > Data Feeds and click the Add New Data Feed button.
    

2. Search for ServiceNow Users and click it as shown below.

   

3. Click on the API Ingest option for collection method.

   

4. Enter feed contact information and scroll down.
    

5. In the configuration page, confirm the following:

   • Authorization Method: OAuth2

   • API Base URL: Replace <instance> with your ServiceNow Instance.

   • Username: Paste the User ID.

   • Password: Paste the Password .

   • Client Key: Paste the Client ID generated earlier in the ServiceNow Platform.

   • Client Secret: Paste the Client Secret generated earlier in the ServiceNow Platform.

   • Token URL: Replace <instance> with your ServiceNow Instance.

   • Event Types: Preselected for all the event types that integration pulls.

   • Include Inactive Users: Select checkbox if you want to include the inactive ServiceNow users along with the ServiceNow active users.
      

6. Click Submit.

Troubleshooting Tips

• Ensure the client key, client secret, instance, username and password are pasted correctly. Since you cannot view the client key and secret after the 1^st time, re-create the creds, paste it on a text editor to ensure no spaces or unexpected characters are included and reconfigure the DataBee feed.

• Make sure the required user role is assigned.