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.
Find Iru Endpoint App
Find Iru Endpoint.
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.
Access ServiceNow
Using a ServiceNow admin account, log in to your ServiceNow tenant (.service-now.com).
Navigate to System OAuth
In the Filter navigator, search for System OAuth.
Open Application Registry
Click Application Registry.
Create OAuth Endpoint
Click Create an OAuth API endpoint for external clients.
Configure OAuth App
Give the OAuth app a name. (Example: iru_endpoint_oauth_api)
Submit Configuration
Click Submit.
Access OAuth App
Go back to the OAuth app that you just created.
Copy Client ID
Highlight and copy the Client ID.
Reveal Client Secret
Reveal the Client Secret by clicking the padlock.
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.
Access ServiceNow
Using a ServiceNow admin account, log in to your ServiceNow tenant (.service-now.com).
Navigate to Users
In the Filter navigator, search for Users.
Open User Administration
Under User Administration, click Users.
Create New User
Click New to add a new user.
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.
Set Web Service Access
Be sure to select Web service access only.
Submit User Creation
Click Submit.
Set User Password
Click on the new user that was just created, and click Set Password.
Generate Password
Click Generate to create the new password.
Copy Password
Copy the new password.
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.
Close Password Dialog
Click Close to go back to the Users page.
Access User Roles
While still on the user page, go to Roles.
Add Required Roles
Add the following roles to the service account user:
- cmdb_read
- import_transformer
- rest_api_explorer
Verify Role Assignment
There should be a total of six new roles assigned. Three assigned and three inherited.
Save User Configuration
To complete the user creation, click Save.
Troubleshooting
Verify that Iru Endpoint is a Discovery Source
Access Dictionary
In ServiceNow, enter Dictionary in the Filter navigator.
Open Dictionary
Under System Definition, click Dictionary.
Search for Discovery Source
In the Dictionary Entries search ensure that Column name is selected and then enter the column name discovery_source.
Select CMDB Table
Click on the cmdb_ci table.
Access Choices Tab
Scroll down and select the Choices tab.
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.
Access Fix Scripts
In ServiceNow, enter Fix Script in the Filter navigator.
Open Fix Scripts
Under System Definition, click Fix Scripts.
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.
Select Fix Script
Click on the iru_endpoint_fix_script table.
Run Fix Script
Click Run Fix Script.
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.