- 30 Jan 2025
-
DarkLight
-
PDF
Application Dependencies
- Updated on 30 Jan 2025
-
DarkLight
-
PDF
These are the application dependencies that enable the Itential ServiceNow Application to run:
- Itential Platform
- ServiceNow Permissions
- Network Requirements
- Credentials
Itential Platform
Versions
The Itential ServiceNow Application requires an instance of the Itential Platform running version 2022.x, 2023.x, or later - or running Itential Platform from the Itential Cloud Service.
API Endpoints
Authentication
/login
/oauth/token
Forms
/json-forms/forms/${formId}
Health
/health/server
Operations Manager
/operations-manager/jobs/${id}
/operations-manager/jobs/cancel
/operations-manager/automations
/operations-manager/triggers
/operations-manager/triggers/manual/${triggerId}/run
/operations-manager/triggers/endpoint/${apiEndpoint}
Transformations
/transformations/${id}
Generic Endpoint
It's important to know the generic endpoint can vary. The primary use of this call is to make all API calls associated with dynamic data in the forms (e.g., adapter calls to retrieve the data for the drop down). This is because there is no way for the application to know these calls in advance of having to make them. In addition, all of these calls will have unique paths based on the adapter and the action within the adapter.
ServiceNow Permissions
The required permissions and roles to use when setting up the Application within ServiceNow are:
x_itent_admin
- This role allows the user to have administrative rights on the Itential ServiceNow Application. Admins have the ability to update the IAP Instance Config table. |x_itent_user
- This role allows the user to have rights to use the Itential ServiceNow Application. They will only be able to use the IAP Instances within the IAP Instance Config table that allow thex_itent_user
role.
Network Requirements
To integrate to Itential, the ServiceNow server must be able to send API calls to the Itential server. If there are firewalls, at a minimum, the port and IP address you use for access to Itential (e.g. 3443
) must be opened from ServiceNow to Itential.
If a fully-qualified domain name (FQDN) is used instead of a specific IP address, it will be important to validate that the ServiceNow server will be able to translate the FQDN to the appropriate IP address.
Another solution that will allow the ServiceNow Server to connect to the Itential server is to utilize a MID Server. The MID Server should provide a route from the ServiceNow server to the Itential Server. You should follow the ServiceNow process for installing a MID Server. Once it is installed and configured in ServiceNow, you can add the MID Server reference and name to the Itential Platform Instance Config table for your Itential Platform instance.
Credentials
To integrate the ServiceNow server to Itential, you must know how to authenticate to your instance of Itential and configure the Itential ServiceNow Application accordingly.
In the latest version of the application, sensitive information is now hidden by using the ServiceNow Password2 data type. This means the password
, token
and client_secret
will now appear masked in the Itential Platform instances config table instead of being clearly visible. Even if you already had your Itential Platform instance configured, these fields will still be masked in the Itential Platform instances config table now. Although there are differences in the GUI between pre-existing (earlier version) instances and newer instances, the code has been written to handle both scenarios.
In 2023.1, on-premises instances of Itential support OAuth 2.0 authentication. This allows you to create a service account to get a client ID and secret which the Itential ServiceNow Application can use to authenticate to Itential.
This ability within Itential was introduced only in Itential Platform 2023.1. Earlier versions of Itential Platform only supported username and password authentication.
All Itential cloud instances support API key authentication. Itential Cloud Operations can assist in getting you an API key to use to integrate with Itential. Please contact your Itential technical representative directly or open a support ticket.