In IdentityNow, an integration is a method of linking functionality offered by a third-party vendor to functionality available in IdentityNow. For example, this document addresses the Duo integration, which allows you to use Duo functionality for strong authentication.
NOTES:
- All RESTful APIs present in this document can change at any point without notice. Always refer to this documentation for the latest supported RESTful APIs to complete this operation.
- This API currently supports only the Duo integration.
IMPORTANT: These APIs are being deprecated in favor of the IdentityNow Platform APIs. While these APIs will continue to be available for the foreseeable future, SailPoint recommends that you transition to the new versions as soon as possible. For detailed information about all new platform APIs, visit the SailPoint API Reference.
Working with IdentityNow Integrations
Using the APIs described in this doc, you can:
- Configure an integration by defining its required properties
- View a list of existing integrations
- View the properties of an existing integration
- Execute operations on an existing integration
Prerequisites:
- Sign in to the org as an administrator. Click Admin and strong authenticate.
- Open your preferred tool for making API calls
NOTE: If you're making these API calls, you'll need to use on of our supported authentication methods. As a best practice SailPoint recommends using OAuth 2. Also, the endpoint you use must be changed slightly based on the authentication method. For details, see the Authentication section of the Developer portal documentation.
Configure a Duo Integration
Configuring an existing integration involves first getting the id of the Duo integration service and then using the integration's ID to define the values for the required parameters.
NOTE: To configure this integration, you must have already created a Duo account with an integration type of Auth API.
Complete the following steps:
|
1. Make the following call: GET <org>/api/integration/get?name=duo
where <org> is the URL for your IdentityNow org.
2. Note the value of id for later APIs. |
 |
|
3. Make the following call:
POST https:// <org>/api/integration/update/<id>
where <org> is the URL for your IdentityNow org and <id> is the ID from step 2.
4. Provide JSON that includes the following parameters as needed for the integration you are defining. These values correspond to information provided by Duo when your organization's integration was created:
|
 |
View a List of Existing Integrations
Use this API to see a list of all integrations configured for your organization.
NOTE: There will be only one object per integration for a cloud.
|
GET <org>/api/integration/list
where <org> is the URL for your IdentityNow org.
A response similar to the image on the right should be returned. Note the value of id for later APIs. |
 |
View the Properties of a Specific Integration
Make this API call to view information about an integration.
|
In Enter request URL here, enter the following:
GET <org>/api/integration/get/<id>
where <org> is the URL for your IdentityNow org and <id> is the ID from step 2 in Configure a Duo Integration. |
|
| A response similar to the image on the right should be returned. Note that this also returns the values of the parameters used to define the integration in Configure a Duo Integration. |  |
Execute a Test Operation on Duo Integration
This API is designed to support any number of operations you might want to execute on an integration. However, currently the only operation you can execute on a Duo integration is test.
|
1. In Enter request URL here, enter the following:
POST <org>/api/integration/execute
where <org> is the URL for the your IdentityNow org. |
|
|
2. Enter JSON that matches the content in the image on the right, using the parameter name value needed for the integration you want to test:
|
 |
