DataAccessSecurity

Use this API to trigger and manage DAS tasks such as scans-starting them on demand, updating schedules, and retrieving statuses.

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

Method	HTTP request	Description
Suspend-V2025Task	POST `/das/tasks/cancel/{id}`	Cancel a DAS task.
New-V2025Schedule	POST `/das/tasks/schedules`	Create a new schedule.
Remove-V2025Schedule	DELETE `/das/tasks/schedules/{id}`	Delete a DAS schedule.
Remove-V2025Task	DELETE `/das/tasks/{id}`	Delete a DAS task.
Get-V2025Schedule	GET `/das/tasks/schedules/{id}`	Get a DAS schedule.
Get-V2025Schedules	GET `/das/tasks/schedules`	List all schedules.
Get-V2025Task	GET `/das/tasks/{id}`	Get a DAS task.
Get-V2025Tasks	GET `/das/tasks`	Lists all DAS tasks.
Send-V2025Schedule	PUT `/das/tasks/schedules/{id}`	Update a schedule.
Start-V2025TaskRerun	POST `/das/tasks/rerun/{id}`	Rerun a DAS task.

cancel-task

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

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	Int64	True	The unique identifier of the task to cancel.

Return type

(empty response body)

Responses

Code	Description	Data Type
204	No Content
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Id = 1001 # Int64 | The unique identifier of the task to cancel.

# Cancel a DAS task.

try {
    Suspend-V2025Task -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Suspend-V2025Task -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025Task"
    Write-Host $_.ErrorDetails
}

[Back to top]

create-schedule

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	CreateScheduleRequest	CreateScheduleRequest	True

Return type

Int64

Responses

Code	Description	Data Type
200	OK	Int64
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

$CreateScheduleRequest = @"{
  "scheduleTaskName" : "Daily Data Sync",
  "scheduleType" : "Daily",
  "active" : true,
  "interval" : 1440,
  "startTime" : 1762237200,
  "endTime" : 1762240800,
  "taskTypeName" : "DataSync",
  "daysOfWeek" : [ "Monday", "Wednesday", "Friday" ],
  "applicationId" : 2001,
  "runAfterScheduleTaskId" : 1000
}"@

# Create a new schedule.

try {
    $Result = ConvertFrom-V2025JsonToCreateScheduleRequest -Json $CreateScheduleRequest
    New-V2025Schedule -CreateScheduleRequest $Result 
    
    # Below is a request that includes all optional parameters
    # New-V2025Schedule -CreateScheduleRequest $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Schedule"
    Write-Host $_.ErrorDetails
}

[Back to top]

delete-schedule

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

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	Int64	True	The unique identifier of the schedule to delete.

Return type

(empty response body)

Responses

Code	Description	Data Type
204	No Content
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Id = 1001 # Int64 | The unique identifier of the schedule to delete.

# Delete a DAS schedule.

try {
    Remove-V2025Schedule -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Remove-V2025Schedule -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Schedule"
    Write-Host $_.ErrorDetails
}

[Back to top]

delete-task

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

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	Int64	True	The unique identifier of the task to delete.

Return type

(empty response body)

Responses

Code	Description	Data Type
204	No Content
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Id = 1001 # Int64 | The unique identifier of the task to delete.

# Delete a DAS task.

try {
    Remove-V2025Task -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Remove-V2025Task -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Task"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-schedule

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

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	Int64	True	The unique identifier of the schedule to retrieve.

Return type

ScheduleInfo

Responses

Code	Description	Data Type
200	A schedule object.	ScheduleInfo
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Id = 1001 # Int64 | The unique identifier of the schedule to retrieve.

# Get a DAS schedule.

try {
    Get-V2025Schedule -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-V2025Schedule -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Schedule"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-schedules

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

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Query	Filters	String	(optional)	Filter 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
Query	Limit	Int32	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	Offset	Int32	(optional) (default to 0)	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
Query	Count	Boolean	(optional) (default to $false)	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.

Return type

ScheduleInfo[]

Responses

Code	Description	Data Type
200	List of Schedule objects.	ScheduleInfo[]
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Filters = 'ScheduleType eq "Daily" and startTime eq 1762237200' # String | 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)
$Limit = 250 # Int32 | 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) (default to 250)
$Offset = 0 # Int32 | 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) (default to 0)
$Count = $true # 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)

# List all schedules.

try {
    Get-V2025Schedules 
    
    # Below is a request that includes all optional parameters
    # Get-V2025Schedules -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Schedules"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-task

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

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	Int64	True	The unique identifier of the task to retrieve.

Return type

TaskInfo

Responses

Code	Description	Data Type
200	A Task object.	TaskInfo
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Id = 1001 # Int64 | The unique identifier of the task to retrieve.

# Get a DAS task.

try {
    Get-V2025Task -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-V2025Task -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Task"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-tasks

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

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Query	Filters	String	(optional)	Filter 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 ""DataSync"" and endBeforeTime eq 1762240800
Query	Limit	Int32	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	Offset	Int32	(optional) (default to 0)	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
Query	Count	Boolean	(optional) (default to $false)	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.

Return type

TaskInfo[]

Responses

Code	Description	Data Type
200	OK. Returns a list of Data Access Security tasks.	TaskInfo[]
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Filters = 'TaskTypeName eq "DataClassification and EndBeforeTime eq 1762240800" # String | 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 ""DataSync"' and endBeforeTime eq 1762240800 (optional)
$Limit = 250 # Int32 | 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) (default to 250)
$Offset = 0 # Int32 | 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) (default to 0)
$Count = $true # 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)

# Lists all DAS tasks.

try {
    Get-V2025Tasks 
    
    # Below is a request that includes all optional parameters
    # Get-V2025Tasks -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Tasks"
    Write-Host $_.ErrorDetails
}

[Back to top]

put-schedule

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	Int64	True	The unique identifier of the schedule to update.
Body	UpdateScheduleRequest	UpdateScheduleRequest	True

Return type

(empty response body)

Responses

Code	Description	Data Type
204	No Content
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

$Id = 1001 # Int64 | The unique identifier of the schedule to update.
$UpdateScheduleRequest = @"{
  "scheduleTaskName" : "Daily Data Sync",
  "scheduleType" : "Daily",
  "active" : true,
  "interval" : 1440,
  "startTime" : 1762237200,
  "endTime" : 1762240800,
  "taskTypeName" : "DataSync",
  "daysOfWeek" : [ "Monday", "Wednesday", "Friday" ],
  "applicationId" : 2001,
  "runAfterScheduleTaskId" : 1000
}"@

# Update a schedule.

try {
    $Result = ConvertFrom-V2025JsonToUpdateScheduleRequest -Json $UpdateScheduleRequest
    Send-V2025Schedule -Id $Id -UpdateScheduleRequest $Result 
    
    # Below is a request that includes all optional parameters
    # Send-V2025Schedule -Id $Id -UpdateScheduleRequest $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Schedule"
    Write-Host $_.ErrorDetails
}

[Back to top]

start-task-rerun

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

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	Int64	True	The unique identifier of the task to rerun.

Return type

(empty response body)

Responses

Code	Description	Data Type
204	No Content
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Id = 1001 # Int64 | The unique identifier of the task to rerun.

# Rerun a DAS task.

try {
    Start-V2025TaskRerun -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Start-V2025TaskRerun -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025TaskRerun"
    Write-Host $_.ErrorDetails
}

[Back to top]

cancel-task​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

create-schedule​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

delete-schedule​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

delete-task​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-schedule​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-schedules​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-task​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-tasks​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

put-schedule​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

start-task-rerun​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

cancel-task

Parameters

Return type

Responses

HTTP request headers

Example

create-schedule

Parameters

Return type

Responses

HTTP request headers

Example

delete-schedule

Parameters

Return type

Responses

HTTP request headers

Example

delete-task

Parameters

Return type

Responses

HTTP request headers

Example

get-schedule

Parameters

Return type

Responses

HTTP request headers

Example

get-schedules

Parameters

Return type

Responses

HTTP request headers

Example

get-task

Parameters

Return type

Responses

HTTP request headers

Example

get-tasks

Parameters

Return type

Responses

HTTP request headers

Example

put-schedule

Parameters

Return type

Responses

HTTP request headers

Example

start-task-rerun

Parameters

Return type

Responses

HTTP request headers

Example