Skip to main content

Installing the Iru Endpoint ServiceNow App

If not already, you will need to install the Iru Endpoint ServiceNow Integration Hub app in your ServiceNow instance. Installing the app will set up some of the required dependencies in your ServiceNow tenant.
1

Access ServiceNow Store

Go to the ServiceNow store.
2

Find Iru Endpoint App

Find Iru Endpoint.
3

Install Application

Install the Iru Endpoint integration application by clicking on Get. You may need to authenticate to the ServiceNow store before being able to install the app. The credentials used should have the ability to install Integration Hub Store apps.

Creating an OAuth App

Iru Endpoint uses a ServiceNow OAuth API client that leverages the Grant Type “Resource Owner Password Credentials (ROPC)” to request access and refresh tokens to interact with the ServiceNow instance.
1

Access ServiceNow

Using a ServiceNow admin account, log in to your ServiceNow tenant (.service-now.com).
2

Navigate to System OAuth

In the Filter navigator, search for System OAuth.
3

Open Application Registry

Click Application Registry.
4

Create OAuth Endpoint

Click Create an OAuth API endpoint for external clients.
5

Configure OAuth App

Give the OAuth app a name. (Example: iru_endpoint_oauth_api)
6

Set Redirect URL

In the Redirect URL field enter https://iru.io.
7

Submit Configuration

Click Submit.
8

Access OAuth App

Go back to the OAuth app that you just created.
9

Copy Client ID

Highlight and copy the Client ID.
10

Reveal Client Secret

Reveal the Client Secret by clicking the padlock.
11

Copy Client Secret

Highlight and copy the Client Secret, or optionally, If you enter your own client secret, be sure to click update to save the change.

Adding a Service Account

The service account user credentials are used to configure the ServiceNow integration in Iru Endpoint.
Any ServiceNow user account can be used as long as it has access to web services, and has the following roles assigned: cmdb_read, import_transformer, and rest_api_explorer. However, In general, it is good practice to create separate service accounts for each integration.
1

Access ServiceNow

Using a ServiceNow admin account, log in to your ServiceNow tenant (.service-now.com).
2

Navigate to Users

In the Filter navigator, search for Users.
3

Open User Administration

Under User Administration, click Users.
4

Create New User

Click New to add a new user.
5

Configure User Details

Enter a descriptive name for the user. (Example: iru_endpoint_rest_api_user). Copy the username to a safe place. You will use this credential when setting up the integration in Iru Endpoint.
  • Optionally, enter any additional information required by your organization.
6

Set Web Service Access

Be sure to select Web service access only.
7

Submit User Creation

Click Submit.
8

Set User Password

Click on the new user that was just created, and click Set Password.
9

Generate Password

Click Generate to create the new password.
10

Copy Password

Copy the new password.
11

Save Password

Click Save Password. Be sure to save this password in a safe place. This password will be used in Iru Endpoint when configuring the ServiceNow integration.
12

Close Password Dialog

Click Close to go back to the Users page.
13

Access User Roles

While still on the user page, go to Roles.
14

Edit Roles

Click Edit.
15

Add Required Roles

Add the following roles to the service account user:
  • cmdb_read
  • import_transformer
  • rest_api_explorer
16

Verify Role Assignment

There should be a total of six new roles assigned. Three assigned and three inherited.
17

Save User Configuration

To complete the user creation, click Save.

Troubleshooting

Verify that Iru Endpoint is a Discovery Source

1

Access Dictionary

In ServiceNow, enter Dictionary in the Filter navigator.
2

Open Dictionary

Under System Definition, click Dictionary.
3

Search for Discovery Source

In the Dictionary Entries search ensure that Column name is selected and then enter the column name discovery_source.
4

Select CMDB Table

Click on the cmdb_ci table.
5

Access Choices Tab

Scroll down and select the Choices tab.
6

Verify Iru Endpoint

Make sure that Iru Endpoint is listed. If you do not see Iru Endpoint right away you can search for the Label Iru Endpoint.

If Iru Endpoint does not show up as a Discovery Source

This section describes how to run the iru_endpoint_fix_script manually in the event that Iru Endpoint does not automatically show up as a Discovery Source after installation of the Iru Endpoint Integration Hub application.
1

Access Fix Scripts

In ServiceNow, enter Fix Script in the Filter navigator.
2

Open Fix Scripts

Under System Definition, click Fix Scripts.
3

Search for Fix Script

In the Fix Scripts search ensure that Name is selected and then enter the fix script name iru_endpoint_fix_script.
4

Select Fix Script

Click on the iru_endpoint_fix_script table.
5

Run Fix Script

Click Run Fix Script.
6

Execute in Background

In the Run Fix Script modal, click Proceed in Background.
Now Iru Endpoint should be listed as a Discovery source choice in ServiceNow.

Next Steps

Iru Endpoint Configuration for the Iru Endpoint ServiceNow integration.

Considerations

Service Account Security: Create dedicated service accounts for each integration rather than using existing user accounts to maintain security and audit trails. OAuth Configuration: Ensure the OAuth app is configured with the correct redirect URL (https://iru.io) and that client credentials are securely stored. Role Requirements: The service account must have the following roles: cmdb_read, import_transformer, and rest_api_explorer for proper integration functionality. Discovery Source Verification: After installation, verify that Iru Endpoint appears as a discovery source in the ServiceNow dictionary to ensure proper data synchronization. Troubleshooting: If the integration doesn’t work properly, check that the fix script has been run and that all required roles are assigned to the service account.