- 13 Mar 2024
-
DarkLight
-
PDF
Configuring Integrations
- Updated on 13 Mar 2024
-
DarkLight
-
PDF
The main user interfaces (UI) for configuring Integrations through Admin Essentials is described below. User interactions occur primarily through the dialog views for Integration Details and Integration Model Details, respectively. Please note that available views, features, and interactions in the UI can be limited based on user permissions.
Create an Integration Using an Integration Model
To create an integration, click the plus (+) sign in the top-left toolbar of Admin Essentials to open a new dialog. When creating an integration, the user can make a selection from a list of Integration Models. Use the search bar to narrow the results. Once you click the Create button, you will be redirected to the Integration Details page.
Figure 1: Create New Integration
Integration Details (Service Config)
The main landing page for Integration Details is shown below. If your integration has properties to edit, they will be displayed here in a form. If not, properties can be configured and edited in the Advanced view (if the user has been granted permission through the generic Integrations - updateIntegration
method). The Advanced service configuration view is enabled (displayed) by using the toggle switch in the upper-right corner.
Figure 2: Integration Details View
From the Advanced view, the More button (stacked dots icon) next to the toggle switch can be used to clone or delete an integration if the user has been granted permission. Authorization to clone an integration is set with the Integrations - createIntegration
permission method. To delete, the Integrations - deleteIntegration
method is used.
Figure 3: Advanced Configuration View
SSL Configuration for Integrations
Itential has created two SSL configuration properties for Integrations. These properties are used when making integration requests to a service even if it has an invalid TLS certificate.
Property Schema
"tls":{
"enabled":false,
"rejectUnauthorized":false
}
The schema allows an integration instance to have configurable TLS properties to enable/disable the rejectUnauthorized
property. This will allow users to bypass HTTPS TLS certificate checks.
Property | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Enables certificate request from endpoint and verify retrieved certificate. |
rejectUnauthorized | boolean | false | If true, the request will reject a connection that is not authorized with valid CAs. This option only has an effect if "enabled" is on. |
Integration Logging
Log Levels are controlled by configurations within Admin Essentials. Increasing the size of the log level will impact all of IAP, not just Integrations.
For related information, refer to the:
- Logger section under Profile Properties.
- IAP Event Logs for log settings and best practices.
- Itential Developers Log Class document.