Skip to main content

DataAccessSecurityApi

Use this API to enable data ownership election campaigns, assign resource owners, and respond to identity lifecycle events to maintain continuous accountability. This API can also trigger and manage DAS tasks such as scans-starting them on demand, updating configurations or schedules, and retrieving statuses. Additionally, you can onboard and manage applications at scale by creating and configuring them, setting scanning schedules, retrieving metadata, and associating them with Virtual Appliances and Identity Collectors.

All URIs are relative to https://sailpoint.api.identitynow.com

MethodHTTP requestDescription
cancel-task-v1POST /das/v1/tasks/cancel/{id}Cancel a DAS task.
create-application-v1POST /das/v1/applicationsCreate application
create-identity-collector-v1POST /das/identity-collectors/v1Create identity collector
create-schedule-v1POST /das/v1/tasks/schedulesCreate a new schedule.
das-v1-owners-assign-postPOST /das/v1/owners/assignAssign owner to application resource.
das-v1-owners-owner-identity-id-resources-getGET /das/v1/owners/{ownerIdentityId}/resourcesList resources for owner.
das-v1-owners-reelect-postPOST /das/v1/owners/reelectRe-elect resource owner.
das-v1-owners-resources-resource-id-getGET /das/v1/owners/resources/{resourceId}List owners for resource.
das-v1-owners-source-identity-id-reassign-destination-identity-id-postPOST /das/v1/owners/{sourceIdentityId}/reassign/{destinationIdentityId}Reassign resource owner.
delete-application-v1DELETE /das/v1/applications/{id}Delete an application by identifier.
delete-identity-collector-v1DELETE /das/identity-collectors/v1/{id}Delete identity collector by identifier
delete-schedule-v1DELETE /das/v1/tasks/schedules/{id}Delete a DAS schedule.
delete-task-v1DELETE /das/v1/tasks/{id}Delete a DAS task.
get-application-v1GET /das/v1/applications/{id}Retrieve application details by identifier.
get-applications-v1GET /das/v1/applicationsSearch applications in DAS.
get-owners-v1GET /das/v1/owners/applications/{appId}Retrieve owners per application.
get-schedule-v1GET /das/v1/tasks/schedules/{id}Get a DAS schedule.
get-schedules-v1GET /das/v1/tasks/schedulesList all schedules.
get-task-v1GET /das/v1/tasks/{id}Get a DAS task.
get-tasks-v1GET /das/v1/tasksLists all DAS tasks.
list-identity-collectors-v1GET /das/identity-collectors/v1List identity collectors
put-application-v1PUT /das/v1/applications/{id}Update application by identifier.
put-identity-collector-v1PUT /das/identity-collectors/v1/{id}Update identity collector by identifier
put-schedule-v1PUT /das/v1/tasks/schedules/{id}Update a schedule.
start-task-rerun-v1POST /das/v1/tasks/rerun/{id}Rerun a DAS task.

cancel-task-v1

Cancel a DAS task. This end-point sends a request to cancel a task in Data Access Security.

API Spec

Parameters

NameTypeDescriptionNotes
idnumberThe unique identifier of the task to cancel.[default to undefined]

Return type

(empty response body)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const id: number = 1001; // The unique identifier of the task to cancel.
const result = await apiInstance.cancelTaskV1({ id: id });
console.log(result);

[Back to top]

create-application-v1

Create application This endpoint creates a new application in Data Access Security with the specified configuration.

API Spec

Parameters

NameTypeDescriptionNotes
basecreateapplicationrequestBasecreateapplicationrequestRequest body containing the details required to create a new application.

Return type

(empty response body)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Basecreateapplicationrequest } from 'sailpoint-api-client/dist/data_access_security/api';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const basecreateapplicationrequest: Basecreateapplicationrequest = ; // Request body containing the details required to create a new application.
const result = await apiInstance.createApplicationV1({ basecreateapplicationrequest: basecreateapplicationrequest });
console.log(result);

[Back to top]

create-identity-collector-v1

Create identity collector This endpoint creates a new identity collector in Data Access Security for the specified source. The identity collector type is derived from the source.

API Spec

Parameters

NameTypeDescriptionNotes
createidentitycollectorrequestCreateidentitycollectorrequestRequest body containing the details required to create a new identity collector.

Return type

CreateIdentityCollectorV1200Response

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Createidentitycollectorrequest } from 'sailpoint-api-client/dist/data_access_security/api';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const createidentitycollectorrequest: Createidentitycollectorrequest = ; // Request body containing the details required to create a new identity collector.
const result = await apiInstance.createIdentityCollectorV1({ createidentitycollectorrequest: createidentitycollectorrequest });
console.log(result);

[Back to top]

create-schedule-v1

Create a new schedule.

API Spec

Parameters

NameTypeDescriptionNotes
createschedulerequestCreateschedulerequest

Return type

number

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Createschedulerequest } from 'sailpoint-api-client/dist/data_access_security/api';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const createschedulerequest: Createschedulerequest = ; //
const result = await apiInstance.createScheduleV1({ createschedulerequest: createschedulerequest });
console.log(result);

[Back to top]

das-v1-owners-assign-post

Assign owner to application resource.

API Spec

Parameters

NameTypeDescriptionNotes
assignresourceownerrequestAssignresourceownerrequestThe request body must contain the application ID, resource path, and identity ID to be assigned as the resource owner.

Return type

number

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Assignresourceownerrequest } from 'sailpoint-api-client/dist/data_access_security/api';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const assignresourceownerrequest: Assignresourceownerrequest = ; // The request body must contain the application ID, resource path, and identity ID to be assigned as the resource owner.
const result = await apiInstance.dasV1OwnersAssignPost({ assignresourceownerrequest: assignresourceownerrequest });
console.log(result);

[Back to top]

das-v1-owners-owner-identity-id-resources-get

List resources for owner.

API Spec

Parameters

NameTypeDescriptionNotes
ownerIdentityIdstringUnique identifier for the owner. This should be a UUID representing the owner's identity.[default to undefined]
limitnumberNot applicable for this endpoint. Do not use.[optional] [default to 250]
offsetnumberNot applicable for this endpoint. Do not use.[optional] [default to 0]

Return type

Array<Resourcemodel>

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const ownerIdentityId: string = a3f1c2d4-5678-4e9b-8c2d-123456789abc; // Unique identifier for the owner. This should be a UUID representing the owner\&#39;s identity.
const limit: number = 250; // Not applicable for this endpoint. Do not use. (optional)
const offset: number = 0; // Not applicable for this endpoint. Do not use. (optional)
const result = await apiInstance.dasV1OwnersOwnerIdentityIdResourcesGet({ ownerIdentityId: ownerIdentityId });
console.log(result);

[Back to top]

das-v1-owners-reelect-post

Re-elect resource owner.

API Spec

Parameters

NameTypeDescriptionNotes
reelectrequestReelectrequestThe request body must contain details for re-electing a resource owner. Date/time fields should use epoch format in seconds.

Return type

number

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Reelectrequest } from 'sailpoint-api-client/dist/data_access_security/api';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const reelectrequest: Reelectrequest = ; // The request body must contain details for re-electing a resource owner. Date/time fields should use epoch format in seconds.
const result = await apiInstance.dasV1OwnersReelectPost({ reelectrequest: reelectrequest });
console.log(result);

[Back to top]

das-v1-owners-resources-resource-id-get

List owners for resource.

API Spec

Parameters

NameTypeDescriptionNotes
resourceIdnumberUnique identifier for the resource.[default to undefined]
limitnumberNot applicable for this endpoint. Do not use.[optional] [default to 250]
offsetnumberNot applicable for this endpoint. Do not use.[optional] [default to 0]

Return type

Array<string>

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const resourceId: number = 101; // Unique identifier for the resource.
const limit: number = 250; // Not applicable for this endpoint. Do not use. (optional)
const offset: number = 0; // Not applicable for this endpoint. Do not use. (optional)
const result = await apiInstance.dasV1OwnersResourcesResourceIdGet({ resourceId: resourceId });
console.log(result);

[Back to top]

das-v1-owners-source-identity-id-reassign-destination-identity-id-post

Reassign resource owner.

API Spec

Parameters

NameTypeDescriptionNotes
sourceIdentityIdstringUnique identifier for the source owner. This should be a UUID representing the identity to reassign from.[default to undefined]
destinationIdentityIdstringUnique identifier for the destination owner. This should be a UUID representing the identity to reassign to.[default to undefined]

Return type

number

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const sourceIdentityId: string = a3f1c2d4-5678-4e9b-8c2d-123456789abc; // Unique identifier for the source owner. This should be a UUID representing the identity to reassign from.
const destinationIdentityId: string = b4e2d3c5-6789-4f0a-9d3e-234567890bcd; // Unique identifier for the destination owner. This should be a UUID representing the identity to reassign to.
const result = await apiInstance.dasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPost({ sourceIdentityId: sourceIdentityId, destinationIdentityId: destinationIdentityId });
console.log(result);

[Back to top]

delete-application-v1

Delete an application by identifier. This endpoint deletes an application from Data Access Security by its unique identifier.

API Spec

Parameters

NameTypeDescriptionNotes
idnumberThe unique identifier of the application to delete.[default to undefined]

Return type

(empty response body)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const id: number = 12345; // The unique identifier of the application to delete.
const result = await apiInstance.deleteApplicationV1({ id: id });
console.log(result);

[Back to top]

delete-identity-collector-v1

Delete identity collector by identifier This endpoint deletes an identity collector from Data Access Security by its unique identifier.

API Spec

Parameters

NameTypeDescriptionNotes
idnumberThe unique identifier of the identity collector to delete.[default to undefined]

Return type

(empty response body)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const id: number = 12345; // The unique identifier of the identity collector to delete.
const result = await apiInstance.deleteIdentityCollectorV1({ id: id });
console.log(result);

[Back to top]

delete-schedule-v1

Delete a DAS schedule. This end-point sends a request to delete a schedule in Data Access Security.

API Spec

Parameters

NameTypeDescriptionNotes
idnumberThe unique identifier of the schedule to delete.[default to undefined]

Return type

(empty response body)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const id: number = 1001; // The unique identifier of the schedule to delete.
const result = await apiInstance.deleteScheduleV1({ id: id });
console.log(result);

[Back to top]

delete-task-v1

Delete a DAS task. This end-point sends a request to delete a task in Data Access Security.

API Spec

Parameters

NameTypeDescriptionNotes
idnumberThe unique identifier of the task to delete.[default to undefined]

Return type

(empty response body)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const id: number = 1001; // The unique identifier of the task to delete.
const result = await apiInstance.deleteTaskV1({ id: id });
console.log(result);

[Back to top]

get-application-v1

Retrieve application details by identifier. This endpoint retrieves the details of a specific application in Data Access Security by its unique identifier.

API Spec

Parameters

NameTypeDescriptionNotes
idnumberThe unique identifier of the application to retrieve.[default to undefined]

Return type

Applicationitem

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const id: number = 12345; // The unique identifier of the application to retrieve.
const result = await apiInstance.getApplicationV1({ id: id });
console.log(result);

[Back to top]

get-applications-v1

Search applications in DAS. This endpoint lists all the applications in Data Access Security with optional filtering.

API Spec

Parameters

NameTypeDescriptionNotes
filtersstringFilter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: appIds: eq, in tagIds: eq, in statuses: eq, in groupCodes: eq, in virtualAppId: eq appName: eq supportsValidation: eq Supported composite operators are and, or[optional] [default to undefined]
limitnumberMax number of results to return. See V3 API Standard Collection Parameters for more information.[optional] [default to 250]
offsetnumberOffset 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]
countbooleanIf 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<Applicationitem>

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const filters: string = AppType eq 'ActiveDirectory' and Statuses eq 'Passed'; // 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: **appIds**: *eq, in* **tagIds**: *eq, in* **statuses**: *eq, in* **groupCodes**: *eq, in* **virtualAppId**: *eq* **appName**: *eq* **supportsValidation**: *eq* Supported composite operators are *and, or* (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 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 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&#x3D;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.getApplicationsV1({ });
console.log(result);

[Back to top]

get-owners-v1

Retrieve owners per application.

API Spec

Parameters

NameTypeDescriptionNotes
appIdnumberThe unique identifier of the application for which to retrieve owners.[default to undefined]
limitnumberNot applicable for this endpoint. Do not use.[optional] [default to 250]
offsetnumberNot applicable for this endpoint. Do not use.[optional] [default to 0]

Return type

Array<Dataownermodel>

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const appId: number = 2001; // The unique identifier of the application for which to retrieve owners.
const limit: number = 250; // Not applicable for this endpoint. Do not use. (optional)
const offset: number = 0; // Not applicable for this endpoint. Do not use. (optional)
const result = await apiInstance.getOwnersV1({ appId: appId });
console.log(result);

[Back to top]

get-schedule-v1

Get a DAS schedule. This end-point gets a schedule in Data Access Security.

API Spec

Parameters

NameTypeDescriptionNotes
idnumberThe unique identifier of the schedule to retrieve.[default to undefined]

Return type

Scheduleinfo

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const id: number = 1001; // The unique identifier of the schedule to retrieve.
const result = await apiInstance.getScheduleV1({ id: id });
console.log(result);

[Back to top]

get-schedules-v1

List all schedules. This end-point lists all the schedules in Data Access Security.

API Spec

Parameters

NameTypeDescriptionNotes
filtersstringFilter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: scheduleTaskIds: eq, in taskTypeName: eq, in status: eq applicationId: eq fullName: eq nameSubString: eq scheduleType: eq Supported composite operators are and, or[optional] [default to undefined]
limitnumberMax number of results to return. See V3 API Standard Collection Parameters for more information.[optional] [default to 250]
offsetnumberOffset 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]
countbooleanIf 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<Scheduleinfo>

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const filters: string = ScheduleType eq "Daily" and startTime eq 1762237200; // 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: **scheduleTaskIds**: *eq, in* **taskTypeName**: *eq, in* **status**: *eq* **applicationId**: *eq* **fullName**: *eq* **nameSubString**: *eq* **scheduleType**: *eq* Supported composite operators are *and, or* (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 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 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&#x3D;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.getSchedulesV1({ });
console.log(result);

[Back to top]

get-task-v1

Get a DAS task. This end-point gets a task in Data Access Security.

API Spec

Parameters

NameTypeDescriptionNotes
idnumberThe unique identifier of the task to retrieve.[default to undefined]

Return type

Taskinfo

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const id: number = 1001; // The unique identifier of the task to retrieve.
const result = await apiInstance.getTaskV1({ id: id });
console.log(result);

[Back to top]

get-tasks-v1

Lists all DAS tasks. This end-point lists all the tasks in Data Access Security.

API Spec

Parameters

NameTypeDescriptionNotes
filtersstringFilter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: taskIds: eq, in statuses: eq, in taskTypeName: eq, in taskName: eq endBeforeTime: eq Supported composite operators are and, or Example: taskTypeName eq &quot;DataSync&quot; and endBeforeTime eq 1762240800[optional] [default to undefined]
limitnumberMax number of results to return. See V3 API Standard Collection Parameters for more information.[optional] [default to 250]
offsetnumberOffset 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]
countbooleanIf 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<Taskinfo>

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const filters: string = TaskTypeName eq "DataClassification and EndBeforeTime eq 1762240800; // 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: **taskIds**: *eq, in* **statuses**: *eq, in* **taskTypeName**: *eq, in* **taskName**: *eq* **endBeforeTime**: *eq* Supported composite operators are *and, or* Example: taskTypeName eq \&quot;DataSync\&quot; and endBeforeTime eq 1762240800 (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 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 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&#x3D;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.getTasksV1({ });
console.log(result);

[Back to top]

list-identity-collectors-v1

List identity collectors This endpoint lists the identity collectors in Data Access Security with optional filtering and pagination.

Sorting is not supported for this endpoint; supplying the sorters query parameter results in a validation error.

API Spec

Parameters

NameTypeDescriptionNotes
filtersstringFilter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: sourceId: eq type: eq, in id: eq, in Supported composite operators are and, or[optional] [default to undefined]
limitnumberMax number of results to return. See V3 API Standard Collection Parameters for more information.[optional] [default to 250]
offsetnumberOffset 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]
countbooleanIf 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<Identitycollectorlistitem>

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const filters: string = sourceId eq "2c9180835d2e5168015d32f890ca1581"; // 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: **sourceId**: *eq* **type**: *eq, in* **id**: *eq, in* Supported composite operators are *and, or* (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 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 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&#x3D;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.listIdentityCollectorsV1({ });
console.log(result);

[Back to top]

put-application-v1

Update application by identifier. This endpoint updates an existing application in Data Access Security with the specified configuration.

API Spec

Parameters

NameTypeDescriptionNotes
idnumberThe unique identifier of the application to update.[default to undefined]
basecreateapplicationrequestBasecreateapplicationrequestRequest body containing the updated details for the application.

Return type

(empty response body)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Basecreateapplicationrequest } from 'sailpoint-api-client/dist/data_access_security/api';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const id: number = 12345; // The unique identifier of the application to update.
const basecreateapplicationrequest: Basecreateapplicationrequest = ; // Request body containing the updated details for the application.
const result = await apiInstance.putApplicationV1({ id: id, basecreateapplicationrequest: basecreateapplicationrequest });
console.log(result);

[Back to top]

put-identity-collector-v1

Update identity collector by identifier This endpoint updates the name of an existing identity collector in Data Access Security. The sourceId and type cannot be changed and must match the current values.

API Spec

Parameters

NameTypeDescriptionNotes
idnumberThe unique identifier of the identity collector to update.[default to undefined]
updateidentitycollectorrequestUpdateidentitycollectorrequestRequest body containing the updated details for the identity collector.

Return type

(empty response body)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Updateidentitycollectorrequest } from 'sailpoint-api-client/dist/data_access_security/api';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const id: number = 12345; // The unique identifier of the identity collector to update.
const updateidentitycollectorrequest: Updateidentitycollectorrequest = ; // Request body containing the updated details for the identity collector.
const result = await apiInstance.putIdentityCollectorV1({ id: id, updateidentitycollectorrequest: updateidentitycollectorrequest });
console.log(result);

[Back to top]

put-schedule-v1

Update a schedule.

API Spec

Parameters

NameTypeDescriptionNotes
idnumberThe unique identifier of the schedule to update.[default to undefined]
updateschedulerequestUpdateschedulerequest

Return type

(empty response body)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Updateschedulerequest } from 'sailpoint-api-client/dist/data_access_security/api';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const id: number = 1001; // The unique identifier of the schedule to update.
const updateschedulerequest: Updateschedulerequest = ; //
const result = await apiInstance.putScheduleV1({ id: id, updateschedulerequest: updateschedulerequest });
console.log(result);

[Back to top]

start-task-rerun-v1

Rerun a DAS task. This end-point sends a request to re-run a task in Data Access Security.

API Spec

Parameters

NameTypeDescriptionNotes
idnumberThe unique identifier of the task to rerun.[default to undefined]

Return type

(empty response body)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import { DataAccessSecurityApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new DataAccessSecurityApi(configuration);
const id: number = 1001; // The unique identifier of the task to rerun.
const result = await apiInstance.startTaskRerunV1({ id: id });
console.log(result);

[Back to top]