Creating Integration Models 2023.1.x

Integration Models UI

The main user interfaces (UI) for creating and using Integration Models in Admin Essentials are described below. Please note that available views, features, and interactions in the UI can be limited based on user permissions.

How to Create an Integration Model

To create (import) an Integration Model:

1. Login to IAP and navigate to Admin Essentials.

2. Click the Import icon in the top toolbar to display the Import dialog.

3. Select Integration Model from the dropdown. The Import File modal will display.

   Figure 1: Import Dialog
   

4. You can upload your Integration Model File by drag-and-drop, or click Browse Files to find and select the file you want to upload.

   Figure 2: Import File Upload
   

5. Once the file is uploaded, the Name of the Integration Model will pre-populate from the specification file, along with a description. You can change the description, as needed, to provide specific information for your import and to better communicate what this integration is used for within your platform.

6. When you upload a Swagger 2.0 or OpenAPI 3.0 specification file, you can run validation on it using the Validate (✓) button. The OpenAPI specification file must be obtained from the targeted integration. For example, gitlab, amazon, and jenkins provide OpenAPI specifications that properly describe their APIs. Admin Essentials can ingest these files and enable integration with these technologies within IAP.

   Figure 3: Import Swagger File
   

7. Once you click the Import button, and upon successful import, the Integration Model will be added to the collection list in the left sidebar.

   Figure 4: Integration Models
   

8. When you select the Integration Model from the collection list you will be redirected to the Integration Model Details page.

   Figure 5: Integration Model Details
   

Further Reading

Refer to Current Limitations for additional information when creating Integration Models.