SIMIntegrationsApi
Use this API to administer IdentityNow's Service Integration Module, or SIM integration with ServiceNow, so that it converts IdentityNow provisioning actions into tickets in ServiceNow.
ServiceNow is a software platform that supports IT service management and automates common business processes for requesting and fulfilling service requests across a business enterprise.
You must have an IdentityNow ServiceNow ServiceDesk license to use this integration. Contact your Customer Success Manager for more information.
Service Desk integration for IdentityNow and in deprecation - not available for new implementation, as of July 21st, 2021. As per SailPoint's support policy, all existing SailPoint IdentityNow customers using this legacy integration will be supported until July 2022.
All URIs are relative to https://sailpoint.api.identitynow.com
| Method | HTTP request | Description |
|---|---|---|
| create-sim-integration-v1 | POST /sim-integrations/v1 | Create new sim integration |
| delete-sim-integration-v1 | DELETE /sim-integrations/v1/{id} | Delete a sim integration |
| get-sim-integration-v1 | GET /sim-integrations/v1/{id} | Get a sim integration details. |
| get-sim-integrations-v1 | GET /sim-integrations/v1 | List the existing sim integrations. |
| patch-before-provisioning-rule-v1 | PATCH /sim-integrations/v1/{id}/beforeProvisioningRule | Patch a sim beforeprovisioningrule attribute. |
| patch-sim-attributes-v1 | PATCH /sim-integrations/v1/{id} | Patch a sim attribute. |
| put-sim-integration-v1 | PUT /sim-integrations/v1/{id} | Update an existing sim integration |
create-sim-integration-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Create new sim integration Create a new SIM Integrations.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| simintegrationdetails | Simintegrationdetails | DTO containing the details of the SIM integration | |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Servicedeskintegrationdto
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { SIMIntegrationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new SIMIntegrationsApi(configuration);
const simintegrationdetails: Simintegrationdetails = ; // DTO containing the details of the SIM integration
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.createSIMIntegrationV1({ simintegrationdetails: simintegrationdetails });
console.log(result);
delete-sim-integration-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Delete a sim integration Get the details of a SIM integration.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The id of the integration to delete. | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
(empty response body)
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { SIMIntegrationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new SIMIntegrationsApi(configuration);
const id: string = 12345; // The id of the integration to delete.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.deleteSIMIntegrationV1({ id: id });
console.log(result);
get-sim-integration-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Get a sim integration details. Get the details of a SIM integration.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The id of the integration. | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Servicedeskintegrationdto
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { SIMIntegrationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new SIMIntegrationsApi(configuration);
const id: string = 12345; // The id of the integration.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getSIMIntegrationV1({ id: id });
console.log(result);
get-sim-integrations-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
List the existing sim integrations. List the existing SIM integrations.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Array<Servicedeskintegrationdto>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { SIMIntegrationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new SIMIntegrationsApi(configuration);
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getSIMIntegrationsV1({ });
console.log(result);
patch-before-provisioning-rule-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Patch a sim beforeprovisioningrule attribute. Patch a SIM beforeProvisioningRule attribute given a JsonPatch object.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | SIM integration id | [default to undefined] |
| jsonpatch | Jsonpatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. | |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Servicedeskintegrationdto
HTTP request headers
- Content-Type: application/json-patch+json
- Accept: application/json
Example
import { SIMIntegrationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new SIMIntegrationsApi(configuration);
const id: string = 12345; // SIM integration id
const jsonpatch: Jsonpatch = ; // The JsonPatch object that describes the changes of SIM beforeProvisioningRule.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.patchBeforeProvisioningRuleV1({ id: id, jsonpatch: jsonpatch });
console.log(result);
patch-sim-attributes-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Patch a sim attribute. Patch a SIM attribute given a JsonPatch object.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | SIM integration id | [default to undefined] |
| jsonpatch | Jsonpatch | The JsonPatch object that describes the changes of SIM | |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Servicedeskintegrationdto
HTTP request headers
- Content-Type: application/json-patch+json
- Accept: application/json
Example
import { SIMIntegrationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new SIMIntegrationsApi(configuration);
const id: string = 12345; // SIM integration id
const jsonpatch: Jsonpatch = ; // The JsonPatch object that describes the changes of SIM
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.patchSIMAttributesV1({ id: id, jsonpatch: jsonpatch });
console.log(result);
put-sim-integration-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Update an existing sim integration Update an existing SIM integration.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The id of the integration. | [default to undefined] |
| simintegrationdetails | Simintegrationdetails | The full DTO of the integration containing the updated model | |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Servicedeskintegrationdto
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { SIMIntegrationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new SIMIntegrationsApi(configuration);
const id: string = 12345; // The id of the integration.
const simintegrationdetails: Simintegrationdetails = ; // The full DTO of the integration containing the updated model
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.putSIMIntegrationV1({ id: id, simintegrationdetails: simintegrationdetails });
console.log(result);