ServiceDeskIntegrationApi
Use this API to build an integration between Identity Security Cloud and a service desk ITSM (IT service management) solution. Once an administrator builds this integration between Identity Security Cloud and a service desk, users can use Identity Security Cloud to raise and track tickets that are synchronized between Identity Security Cloud and the service desk.
In Identity Security Cloud, administrators can create a service desk integration (sometimes also called an SDIM, or Service Desk Integration Module) by going to Admin > Connections > Service Desk and selecting 'Create.'
To create a Generic Service Desk integration, for example, administrators must provide the required information on the General Settings page, the Connectivity and Authentication information, Ticket Creation information, Status Mapping information, and Requester Source information on the Configure page. Refer to Integrating SailPoint with Generic Service Desk for more information about the process of setting up a Generic Service Desk in Identity Security Cloud.
Administrators can create various service desk integrations, all with their own nuances. The following service desk integrations are available:
All URIs are relative to https://sailpoint.api.identitynow.com
| Method | HTTP request | Description |
|---|---|---|
| create-service-desk-integration-v1 | POST /service-desk-integrations/v1 | Create new service desk integration |
| delete-service-desk-integration-v1 | DELETE /service-desk-integrations/v1/{id} | Delete a service desk integration |
| get-service-desk-integration-template-v1 | GET /service-desk-integrations/v1/templates/{scriptName} | Service desk integration template by scriptname |
| get-service-desk-integration-types-v1 | GET /service-desk-integrations/v1/types | List service desk integration types |
| get-service-desk-integration-v1 | GET /service-desk-integrations/v1/{id} | Get a service desk integration |
| get-service-desk-integrations-v1 | GET /service-desk-integrations/v1 | List existing service desk integrations |
| get-status-check-details-v1 | GET /service-desk-integrations/v1/status-check-configuration | Get the time check configuration |
| patch-service-desk-integration-v1 | PATCH /service-desk-integrations/v1/{id} | Patch a service desk integration |
| put-service-desk-integration-v1 | PUT /service-desk-integrations/v1/{id} | Update a service desk integration |
| update-status-check-details-v1 | PUT /service-desk-integrations/v1/status-check-configuration | Update the time check configuration |
create-service-desk-integration-v1
Create new service desk integration Create a new Service Desk integration.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| servicedeskintegrationdto | Servicedeskintegrationdto | The specifics of a new integration to create |
Return type
Servicedeskintegrationdto
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { ServiceDeskIntegrationApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Servicedeskintegrationdto } from 'sailpoint-api-client/dist/service_desk_integration/api';
const configuration = new Configuration();
const apiInstance = new ServiceDeskIntegrationApi(configuration);
const servicedeskintegrationdto: Servicedeskintegrationdto = ; // The specifics of a new integration to create
const result = await apiInstance.createServiceDeskIntegrationV1({ servicedeskintegrationdto: servicedeskintegrationdto });
console.log(result);
delete-service-desk-integration-v1
Delete a service desk integration Delete an existing Service Desk integration by ID.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of Service Desk integration to delete | [default to undefined] |
Return type
(empty response body)
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { ServiceDeskIntegrationApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new ServiceDeskIntegrationApi(configuration);
const id: string = anId; // ID of Service Desk integration to delete
const result = await apiInstance.deleteServiceDeskIntegrationV1({ id: id });
console.log(result);
get-service-desk-integration-template-v1
Service desk integration template by scriptname This API endpoint returns an existing Service Desk integration template by scriptName.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| scriptName | string | The scriptName value of the Service Desk integration template to get | [default to undefined] |
Return type
Servicedeskintegrationtemplatedto
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { ServiceDeskIntegrationApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new ServiceDeskIntegrationApi(configuration);
const scriptName: string = aScriptName; // The scriptName value of the Service Desk integration template to get
const result = await apiInstance.getServiceDeskIntegrationTemplateV1({ scriptName: scriptName });
console.log(result);
get-service-desk-integration-types-v1
List service desk integration types This API endpoint returns the current list of supported Service Desk integration types.
Parameters
This endpoint does not need any parameter.
Return type
Array<Servicedeskintegrationtemplatetype>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { ServiceDeskIntegrationApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new ServiceDeskIntegrationApi(configuration);
const result = await apiInstance.getServiceDeskIntegrationTypesV1({ });
console.log(result);
get-service-desk-integration-v1
Get a service desk integration Get an existing Service Desk integration by ID.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the Service Desk integration to get | [default to undefined] |
Return type
Servicedeskintegrationdto
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { ServiceDeskIntegrationApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new ServiceDeskIntegrationApi(configuration);
const id: string = anId; // ID of the Service Desk integration to get
const result = await apiInstance.getServiceDeskIntegrationV1({ id: id });
console.log(result);
get-service-desk-integrations-v1
List existing service desk integrations Get a list of Service Desk integration objects.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| offset | number | Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information. | [optional] [default to 0] |
| limit | number | Max number of results to return. See V3 API Standard Collection Parameters for more information. | [optional] [default to 250] |
| sorters | string | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name | [optional] [default to undefined] |
| filters | string | Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: id: eq, in name: eq type: eq, in cluster: eq, in | [optional] [default to undefined] |
| count | boolean | If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information. | [optional] [default to false] |
Return type
Array<Servicedeskintegrationdto>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { ServiceDeskIntegrationApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new ServiceDeskIntegrationApi(configuration);
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const sorters: string = name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional)
const filters: string = name eq "John Doe"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional)
const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const result = await apiInstance.getServiceDeskIntegrationsV1({ });
console.log(result);
get-status-check-details-v1
Get the time check configuration Get the time check configuration of queued SDIM tickets.
Parameters
This endpoint does not need any parameter.
Return type
Queuedcheckconfigdetails
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { ServiceDeskIntegrationApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new ServiceDeskIntegrationApi(configuration);
const result = await apiInstance.getStatusCheckDetailsV1({ });
console.log(result);
patch-service-desk-integration-v1
Patch a service desk integration Update an existing Service Desk integration by ID with a PATCH request.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the Service Desk integration to update | [default to undefined] |
| jsonpatchoperation | Array<Jsonpatchoperation> | A list of SDIM update operations according to the JSON Patch standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. |
Return type
Servicedeskintegrationdto
HTTP request headers
- Content-Type: application/json-patch+json
- Accept: application/json
Example
import { ServiceDeskIntegrationApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Jsonpatchoperation } from 'sailpoint-api-client/dist/service_desk_integration/api';
const configuration = new Configuration();
const apiInstance = new ServiceDeskIntegrationApi(configuration);
const id: string = anId; // ID of the Service Desk integration to update
const jsonpatchoperation: Array<Jsonpatchoperation> = ; // A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed.
const result = await apiInstance.patchServiceDeskIntegrationV1({ id: id, jsonpatchoperation: jsonpatchoperation });
console.log(result);
put-service-desk-integration-v1
Update a service desk integration Update an existing Service Desk integration by ID.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the Service Desk integration to update | [default to undefined] |
| servicedeskintegrationdto | Servicedeskintegrationdto | The specifics of the integration to update |
Return type
Servicedeskintegrationdto
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { ServiceDeskIntegrationApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Servicedeskintegrationdto } from 'sailpoint-api-client/dist/service_desk_integration/api';
const configuration = new Configuration();
const apiInstance = new ServiceDeskIntegrationApi(configuration);
const id: string = anId; // ID of the Service Desk integration to update
const servicedeskintegrationdto: Servicedeskintegrationdto = ; // The specifics of the integration to update
const result = await apiInstance.putServiceDeskIntegrationV1({ id: id, servicedeskintegrationdto: servicedeskintegrationdto });
console.log(result);
update-status-check-details-v1
Update the time check configuration Update the time check configuration of queued SDIM tickets.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| queuedcheckconfigdetails | Queuedcheckconfigdetails | The modified time check configuration |
Return type
Queuedcheckconfigdetails
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { ServiceDeskIntegrationApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Queuedcheckconfigdetails } from 'sailpoint-api-client/dist/service_desk_integration/api';
const configuration = new Configuration();
const apiInstance = new ServiceDeskIntegrationApi(configuration);
const queuedcheckconfigdetails: Queuedcheckconfigdetails = ; // The modified time check configuration
const result = await apiInstance.updateStatusCheckDetailsV1({ queuedcheckconfigdetails: queuedcheckconfigdetails });
console.log(result);