Configuration
- 25 Oct 2024
-
DarkLight
-
PDF
Configuration
- Updated on 25 Oct 2024
-
DarkLight
-
PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
This section of the guide provides information on how to configure an IAP instance using the Itential Automation Services app within the ServiceNow platform.
Configure the Itential Instance
- Click the All tab at the top left-hand corner, click the Itential drop-down menu, and then select the IAP Instances Config option.
- Click the Instance you want to configure, or click the New icon (top right-hand corner) to configure a new instance.
- Type the Name, IP Address (or Hostname) with the port number in the the respective fields.
- You may have to unlock the
hostname
. TheIP/Hostname
should be the URL of the Itential server (e.g.https://myiap.com:3443
). HTTPS will be required.
- You may have to unlock the
Figure 1: IAP Instances Config
Figure 2: Instances Table
Figure 3: New Instance Config Form
- Select the
auth_type
. This field was added in the latest version since thePassword
field is masked whether it has a value or not. Of note, the application and actions should work whether this field is provided or not. - Provide your credentials based on the type of authentication you are using. Credentials will appear masked as you type them and when they are displayed in the table.
- Username/Password
- API Key requires a
static
token. - OAuth 2.0 requires a
client_id
andclient_secret
to retrieve a token.
- Add the Roles that have access to this IAP Instance.
- If using a MID Server to communicate with IAP, provide the reference to the MID Server and the MID Server name.
- To find the reference, use the search icon (magnifying glass) at the end of the **MID_server **field.
- The reference is utilized by Itential Actions and the name is critical for the Client GUI React Application.
- Input the
request_timeout
to set the timeout for the API calls to IAP. If it is not provided, the default timeout within ServiceNow will be used. - Click Submit (upper-right corner) to set the new instance configurations.
Figure 4: Submit New Instance Configurations
IAP Permission Settings
The ServiceNow Application requires the user to have certain permissions within Itential Automation Platform (Itential Cloud).
Role | Itential Platform | Description |
---|---|---|
admin |
Adapter or Application | Ability to get dynamic data from an adapter or IAP Application requires additional permissions. This includes admin for the specific adapter. |
apiread |
JSON Forms | Ability to get a JSON Form associated with the trigger. |
apiread |
Operations Manager | Ability to get a list of automations from IAP. |
apiread |
Operations Manager | Ability to get triggers for an automation from IAP. |
apiread |
Operations Manager | Ability to get information on a triggered Job from IAP. |
apiwrite |
Workflow Engine | Ability to execute a trigger. |
To read how Itential Cloud governs role permissions see → Itential Cloud Group Administration
Figure 5: Roles - JSON Forms
Figure 6: Roles - Operations Manager
Figure 7: Roles - Workflow Engine
Was this article helpful?