sailpoint.data_access_security.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

Method	HTTP request	Description
cancel-task-v1	POST /das/v1/tasks/cancel/{id}	Cancel a DAS task.
create-application-v1	POST /das/v1/applications	Create application
create-identity-collector-v1	POST /das/identity-collectors/v1	Create identity collector
create-schedule-v1	POST /das/v1/tasks/schedules	Create a new schedule.
das-v1-owners-assign-post	POST /das/v1/owners/assign	Assign owner to application resource.
das-v1-owners-owner-identity-id-resources-get	GET /das/v1/owners/{ownerIdentityId}/resources	List resources for owner.
das-v1-owners-reelect-post	POST /das/v1/owners/reelect	Re-elect resource owner.
das-v1-owners-resources-resource-id-get	GET /das/v1/owners/resources/{resourceId}	List owners for resource.
das-v1-owners-source-identity-id-reassign-destination-identity-id-post	POST /das/v1/owners/{sourceIdentityId}/reassign/{destinationIdentityId}	Reassign resource owner.
delete-application-v1	DELETE /das/v1/applications/{id}	Delete an application by identifier.
delete-identity-collector-v1	DELETE /das/identity-collectors/v1/{id}	Delete identity collector by identifier
delete-schedule-v1	DELETE /das/v1/tasks/schedules/{id}	Delete a DAS schedule.
delete-task-v1	DELETE /das/v1/tasks/{id}	Delete a DAS task.
get-application-v1	GET /das/v1/applications/{id}	Retrieve application details by identifier.
get-applications-v1	GET /das/v1/applications	Search applications in DAS.
get-owners-v1	GET /das/v1/owners/applications/{appId}	Retrieve owners per application.
get-schedule-v1	GET /das/v1/tasks/schedules/{id}	Get a DAS schedule.
get-schedules-v1	GET /das/v1/tasks/schedules	List all schedules.
get-task-v1	GET /das/v1/tasks/{id}	Get a DAS task.
get-tasks-v1	GET /das/v1/tasks	Lists all DAS tasks.
list-identity-collectors-v1	GET /das/identity-collectors/v1	List identity collectors
put-application-v1	PUT /das/v1/applications/{id}	Update application by identifier.
put-identity-collector-v1	PUT /das/identity-collectors/v1/{id}	Update identity collector by identifier
put-schedule-v1	PUT /das/v1/tasks/schedules/{id}	Update a schedule.
start-task-rerun-v1	POST /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

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

Return type

(empty response body)

Responses

Code	Description	Data Type	Response headers
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    id = 1001 # int | The unique identifier of the task to cancel. # int | The unique identifier of the task to cancel.

    try:
        # Cancel a DAS task.
        
        DataAccessSecurityApi(api_client).cancel_task_v1(id=id)
        # Below is a request that includes all optional parameters
        # DataAccessSecurityApi(api_client).cancel_task_v1(id)
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->cancel_task_v1: %s\n" % e)

[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

Param Type	Name	Data Type	Required	Description
Body	basecreateapplicationrequest	Basecreateapplicationrequest	True	Request body containing the details required to create a new application.

Return type

(empty response body)

Responses

Code	Description	Data Type	Response headers
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.data_access_security.models.basecreateapplicationrequest import Basecreateapplicationrequest
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    basecreateapplicationrequest = '''sailpoint.data_access_security.Basecreateapplicationrequest()''' # Basecreateapplicationrequest | Request body containing the details required to create a new application.

    try:
        # Create application
        new_basecreateapplicationrequest = Basecreateapplicationrequest.from_json(basecreateapplicationrequest)
        DataAccessSecurityApi(api_client).create_application_v1(basecreateapplicationrequest=new_basecreateapplicationrequest)
        # Below is a request that includes all optional parameters
        # DataAccessSecurityApi(api_client).create_application_v1(new_basecreateapplicationrequest)
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->create_application_v1: %s\n" % e)

[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

Param Type	Name	Data Type	Required	Description
Body	createidentitycollectorrequest	Createidentitycollectorrequest	True	Request body containing the details required to create a new identity collector.

Return type

CreateIdentityCollectorV1200Response

Responses

Code	Description	Data Type	Response headers
200	The identity collector was created successfully.	CreateIdentityCollectorV1200Response	-
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.data_access_security.models.create_identity_collector_v1200_response import CreateIdentityCollectorV1200Response
from sailpoint.data_access_security.models.createidentitycollectorrequest import Createidentitycollectorrequest
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    createidentitycollectorrequest = '''sailpoint.data_access_security.Createidentitycollectorrequest()''' # Createidentitycollectorrequest | Request body containing the details required to create a new identity collector.

    try:
        # Create identity collector
        new_createidentitycollectorrequest = Createidentitycollectorrequest.from_json(createidentitycollectorrequest)
        results = DataAccessSecurityApi(api_client).create_identity_collector_v1(createidentitycollectorrequest=new_createidentitycollectorrequest)
        # Below is a request that includes all optional parameters
        # results = DataAccessSecurityApi(api_client).create_identity_collector_v1(new_createidentitycollectorrequest)
        print("The response of DataAccessSecurityApi->create_identity_collector_v1:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->create_identity_collector_v1: %s\n" % e)

[Back to top]

create-schedule-v1

Create a new schedule.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	createschedulerequest	Createschedulerequest	True

Return type

int

Responses

Code	Description	Data Type	Response headers
200	OK	int	-
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.data_access_security.models.createschedulerequest import Createschedulerequest
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    createschedulerequest = '''sailpoint.data_access_security.Createschedulerequest()''' # Createschedulerequest | 

    try:
        # Create a new schedule.
        new_createschedulerequest = Createschedulerequest.from_json(createschedulerequest)
        results = DataAccessSecurityApi(api_client).create_schedule_v1(createschedulerequest=new_createschedulerequest)
        # Below is a request that includes all optional parameters
        # results = DataAccessSecurityApi(api_client).create_schedule_v1(new_createschedulerequest)
        print("The response of DataAccessSecurityApi->create_schedule_v1:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->create_schedule_v1: %s\n" % e)

[Back to top]

das-v1-owners-assign-post

Assign owner to application resource.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	assignresourceownerrequest	Assignresourceownerrequest	True	The request body must contain the application ID, resource path, and identity ID to be assigned as the resource owner.

Return type

int

Responses

Code	Description	Data Type	Response headers
200	1 - success, otherwise failure.	int	-
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.data_access_security.models.assignresourceownerrequest import Assignresourceownerrequest
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    assignresourceownerrequest = '''sailpoint.data_access_security.Assignresourceownerrequest()''' # Assignresourceownerrequest | The request body must contain the application ID, resource path, and identity ID to be assigned as the resource owner.

    try:
        # Assign owner to application resource.
        new_assignresourceownerrequest = Assignresourceownerrequest.from_json(assignresourceownerrequest)
        results = DataAccessSecurityApi(api_client).das_v1_owners_assign_post(assignresourceownerrequest=new_assignresourceownerrequest)
        # Below is a request that includes all optional parameters
        # results = DataAccessSecurityApi(api_client).das_v1_owners_assign_post(new_assignresourceownerrequest)
        print("The response of DataAccessSecurityApi->das_v1_owners_assign_post:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->das_v1_owners_assign_post: %s\n" % e)

[Back to top]

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

List resources for owner.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	owner_identity_id	str	True	Unique identifier for the owner. This should be a UUID representing the owner's identity.
Query	limit	int	(optional) (default to 250)	Not applicable for this endpoint. Do not use.
Query	offset	int	(optional) (default to 0)	Not applicable for this endpoint. Do not use.

Return type

List[Resourcemodel]

Responses

Code	Description	Data Type	Response headers
200	A list of resources owned by the specified identity was retrieved successfully.	List[Resourcemodel]	-
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.data_access_security.models.resourcemodel import Resourcemodel
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    owner_identity_id = 'a3f1c2d4-5678-4e9b-8c2d-123456789abc' # str | Unique identifier for the owner. This should be a UUID representing the owner's identity. # str | Unique identifier for the owner. This should be a UUID representing the owner's identity.
    limit = 250 # int | Not applicable for this endpoint. Do not use. (optional) (default to 250) # int | Not applicable for this endpoint. Do not use. (optional) (default to 250)
    offset = 0 # int | Not applicable for this endpoint. Do not use. (optional) (default to 0) # int | Not applicable for this endpoint. Do not use. (optional) (default to 0)

    try:
        # List resources for owner.
        
        results = DataAccessSecurityApi(api_client).das_v1_owners_owner_identity_id_resources_get(owner_identity_id=owner_identity_id)
        # Below is a request that includes all optional parameters
        # results = DataAccessSecurityApi(api_client).das_v1_owners_owner_identity_id_resources_get(owner_identity_id, limit, offset)
        print("The response of DataAccessSecurityApi->das_v1_owners_owner_identity_id_resources_get:\n")
        for item in results:
            print(item.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->das_v1_owners_owner_identity_id_resources_get: %s\n" % e)

[Back to top]

das-v1-owners-reelect-post

Re-elect resource owner.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	reelectrequest	Reelectrequest	True	The request body must contain details for re-electing a resource owner. Date/time fields should use epoch format in seconds.

Return type

int

Responses

Code	Description	Data Type	Response headers
200	The number of elections CREATED. In case of failure, some elections may not be STARTED.	int	-
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.data_access_security.models.reelectrequest import Reelectrequest
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    reelectrequest = '''sailpoint.data_access_security.Reelectrequest()''' # Reelectrequest | The request body must contain details for re-electing a resource owner. Date/time fields should use epoch format in seconds.

    try:
        # Re-elect resource owner.
        new_reelectrequest = Reelectrequest.from_json(reelectrequest)
        results = DataAccessSecurityApi(api_client).das_v1_owners_reelect_post(reelectrequest=new_reelectrequest)
        # Below is a request that includes all optional parameters
        # results = DataAccessSecurityApi(api_client).das_v1_owners_reelect_post(new_reelectrequest)
        print("The response of DataAccessSecurityApi->das_v1_owners_reelect_post:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->das_v1_owners_reelect_post: %s\n" % e)

[Back to top]

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

List owners for resource.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	resource_id	int	True	Unique identifier for the resource.
Query	limit	int	(optional) (default to 250)	Not applicable for this endpoint. Do not use.
Query	offset	int	(optional) (default to 0)	Not applicable for this endpoint. Do not use.

Return type

List[str]

Responses

Code	Description	Data Type	Response headers
200	A list of owner identity UUIDs for the specified resource was retrieved successfully.	List[str]	-
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    resource_id = 101 # int | Unique identifier for the resource. # int | Unique identifier for the resource.
    limit = 250 # int | Not applicable for this endpoint. Do not use. (optional) (default to 250) # int | Not applicable for this endpoint. Do not use. (optional) (default to 250)
    offset = 0 # int | Not applicable for this endpoint. Do not use. (optional) (default to 0) # int | Not applicable for this endpoint. Do not use. (optional) (default to 0)

    try:
        # List owners for resource.
        
        results = DataAccessSecurityApi(api_client).das_v1_owners_resources_resource_id_get(resource_id=resource_id)
        # Below is a request that includes all optional parameters
        # results = DataAccessSecurityApi(api_client).das_v1_owners_resources_resource_id_get(resource_id, limit, offset)
        print("The response of DataAccessSecurityApi->das_v1_owners_resources_resource_id_get:\n")
        for item in results:
            print(item.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->das_v1_owners_resources_resource_id_get: %s\n" % e)

[Back to top]

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

Reassign resource owner.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	source_identity_id	str	True	Unique identifier for the source owner. This should be a UUID representing the identity to reassign from.
Path	destination_identity_id	str	True	Unique identifier for the destination owner. This should be a UUID representing the identity to reassign to.

Return type

int

Responses

Code	Description	Data Type	Response headers
200	The number of resources whose owners were overwritten.	int	-
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    source_identity_id = 'a3f1c2d4-5678-4e9b-8c2d-123456789abc' # str | Unique identifier for the source owner. This should be a UUID representing the identity to reassign from. # str | Unique identifier for the source owner. This should be a UUID representing the identity to reassign from.
    destination_identity_id = 'b4e2d3c5-6789-4f0a-9d3e-234567890bcd' # str | Unique identifier for the destination owner. This should be a UUID representing the identity to reassign to. # str | Unique identifier for the destination owner. This should be a UUID representing the identity to reassign to.

    try:
        # Reassign resource owner.
        
        results = DataAccessSecurityApi(api_client).das_v1_owners_source_identity_id_reassign_destination_identity_id_post(source_identity_id=source_identity_id, destination_identity_id=destination_identity_id)
        # Below is a request that includes all optional parameters
        # results = DataAccessSecurityApi(api_client).das_v1_owners_source_identity_id_reassign_destination_identity_id_post(source_identity_id, destination_identity_id)
        print("The response of DataAccessSecurityApi->das_v1_owners_source_identity_id_reassign_destination_identity_id_post:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->das_v1_owners_source_identity_id_reassign_destination_identity_id_post: %s\n" % e)

[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

Param Type	Name	Data Type	Required	Description
Path	id	int	True	The unique identifier of the application to delete.

Return type

(empty response body)

Responses

Code	Description	Data Type	Response headers
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    id = 12345 # int | The unique identifier of the application to delete. # int | The unique identifier of the application to delete.

    try:
        # Delete an application by identifier.
        
        DataAccessSecurityApi(api_client).delete_application_v1(id=id)
        # Below is a request that includes all optional parameters
        # DataAccessSecurityApi(api_client).delete_application_v1(id)
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->delete_application_v1: %s\n" % e)

[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

Param Type	Name	Data Type	Required	Description
Path	id	int	True	The unique identifier of the identity collector to delete.

Return type

(empty response body)

Responses

Code	Description	Data Type	Response headers
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    id = 12345 # int | The unique identifier of the identity collector to delete. # int | The unique identifier of the identity collector to delete.

    try:
        # Delete identity collector by identifier
        
        DataAccessSecurityApi(api_client).delete_identity_collector_v1(id=id)
        # Below is a request that includes all optional parameters
        # DataAccessSecurityApi(api_client).delete_identity_collector_v1(id)
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->delete_identity_collector_v1: %s\n" % e)

[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

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

Return type

(empty response body)

Responses

Code	Description	Data Type	Response headers
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    id = 1001 # int | The unique identifier of the schedule to delete. # int | The unique identifier of the schedule to delete.

    try:
        # Delete a DAS schedule.
        
        DataAccessSecurityApi(api_client).delete_schedule_v1(id=id)
        # Below is a request that includes all optional parameters
        # DataAccessSecurityApi(api_client).delete_schedule_v1(id)
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->delete_schedule_v1: %s\n" % e)

[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

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

Return type

(empty response body)

Responses

Code	Description	Data Type	Response headers
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    id = 1001 # int | The unique identifier of the task to delete. # int | The unique identifier of the task to delete.

    try:
        # Delete a DAS task.
        
        DataAccessSecurityApi(api_client).delete_task_v1(id=id)
        # Below is a request that includes all optional parameters
        # DataAccessSecurityApi(api_client).delete_task_v1(id)
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->delete_task_v1: %s\n" % e)

[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

Param Type	Name	Data Type	Required	Description
Path	id	int	True	The unique identifier of the application to retrieve.

Return type

Applicationitem

Responses

Code	Description	Data Type	Response headers
200	The application details were retrieved successfully.	Applicationitem	-
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.data_access_security.models.applicationitem import Applicationitem
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    id = 12345 # int | The unique identifier of the application to retrieve. # int | The unique identifier of the application to retrieve.

    try:
        # Retrieve application details by identifier.
        
        results = DataAccessSecurityApi(api_client).get_application_v1(id=id)
        # Below is a request that includes all optional parameters
        # results = DataAccessSecurityApi(api_client).get_application_v1(id)
        print("The response of DataAccessSecurityApi->get_application_v1:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->get_application_v1: %s\n" % e)

[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

Param Type	Name	Data Type	Required	Description
Query	filters	str	(optional)	Filter 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
Query	limit	int	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	offset	int	(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	bool	(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

List[Applicationitem]

Responses

Code	Description	Data Type	Response headers
200	A list of applications matching the filter criteria.	List[Applicationitem]	-
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.data_access_security.models.applicationitem import Applicationitem
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    filters = 'AppType eq \'ActiveDirectory\' and Statuses eq \'Passed\'' # str | 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) # str | 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)
    limit = 250 # int | 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) # int | 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 # int | 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) # int | 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 = False # bool | 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) # bool | 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)

    try:
        # Search applications in DAS.
        
        results = DataAccessSecurityApi(api_client).get_applications_v1()
        # Below is a request that includes all optional parameters
        # results = DataAccessSecurityApi(api_client).get_applications_v1(filters, limit, offset, count)
        print("The response of DataAccessSecurityApi->get_applications_v1:\n")
        for item in results:
            print(item.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->get_applications_v1: %s\n" % e)

[Back to top]

get-owners-v1

Retrieve owners per application.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	app_id	int	True	The unique identifier of the application for which to retrieve owners.
Query	limit	int	(optional) (default to 250)	Not applicable for this endpoint. Do not use.
Query	offset	int	(optional) (default to 0)	Not applicable for this endpoint. Do not use.

Return type

List[Dataownermodel]

Responses

Code	Description	Data Type	Response headers
200	OK. Returns a list of DataOwnerModel objects.	List[Dataownermodel]	-
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.data_access_security.models.dataownermodel import Dataownermodel
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    app_id = 2001 # int | The unique identifier of the application for which to retrieve owners. # int | The unique identifier of the application for which to retrieve owners.
    limit = 250 # int | Not applicable for this endpoint. Do not use. (optional) (default to 250) # int | Not applicable for this endpoint. Do not use. (optional) (default to 250)
    offset = 0 # int | Not applicable for this endpoint. Do not use. (optional) (default to 0) # int | Not applicable for this endpoint. Do not use. (optional) (default to 0)

    try:
        # Retrieve owners per application.
        
        results = DataAccessSecurityApi(api_client).get_owners_v1(app_id=app_id)
        # Below is a request that includes all optional parameters
        # results = DataAccessSecurityApi(api_client).get_owners_v1(app_id, limit, offset)
        print("The response of DataAccessSecurityApi->get_owners_v1:\n")
        for item in results:
            print(item.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->get_owners_v1: %s\n" % e)

[Back to top]

get-schedule-v1

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

API Spec

Parameters

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

Return type

Scheduleinfo

Responses

Code	Description	Data Type	Response headers
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.data_access_security.models.scheduleinfo import Scheduleinfo
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    id = 1001 # int | The unique identifier of the schedule to retrieve. # int | The unique identifier of the schedule to retrieve.

    try:
        # Get a DAS schedule.
        
        results = DataAccessSecurityApi(api_client).get_schedule_v1(id=id)
        # Below is a request that includes all optional parameters
        # results = DataAccessSecurityApi(api_client).get_schedule_v1(id)
        print("The response of DataAccessSecurityApi->get_schedule_v1:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->get_schedule_v1: %s\n" % e)

[Back to top]

get-schedules-v1

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

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Query	filters	str	(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	int	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	offset	int	(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	bool	(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

List[Scheduleinfo]

Responses

Code	Description	Data Type	Response headers
200	List of Schedule objects.	List[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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.data_access_security.models.scheduleinfo import Scheduleinfo
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    filters = 'ScheduleType eq \"Daily\" and startTime eq 1762237200' # str | 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) # str | 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 # int | 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) # int | 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 # int | 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) # int | 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 = False # bool | 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) # bool | 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)

    try:
        # List all schedules.
        
        results = DataAccessSecurityApi(api_client).get_schedules_v1()
        # Below is a request that includes all optional parameters
        # results = DataAccessSecurityApi(api_client).get_schedules_v1(filters, limit, offset, count)
        print("The response of DataAccessSecurityApi->get_schedules_v1:\n")
        for item in results:
            print(item.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->get_schedules_v1: %s\n" % e)

[Back to top]

get-task-v1

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

API Spec

Parameters

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

Return type

Taskinfo

Responses

Code	Description	Data Type	Response headers
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.data_access_security.models.taskinfo import Taskinfo
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    id = 1001 # int | The unique identifier of the task to retrieve. # int | The unique identifier of the task to retrieve.

    try:
        # Get a DAS task.
        
        results = DataAccessSecurityApi(api_client).get_task_v1(id=id)
        # Below is a request that includes all optional parameters
        # results = DataAccessSecurityApi(api_client).get_task_v1(id)
        print("The response of DataAccessSecurityApi->get_task_v1:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->get_task_v1: %s\n" % e)

[Back to top]

get-tasks-v1

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

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Query	filters	str	(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	int	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	offset	int	(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	bool	(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

List[Taskinfo]

Responses

Code	Description	Data Type	Response headers
200	OK. Returns a list of Data Access Security tasks.	List[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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.data_access_security.models.taskinfo import Taskinfo
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    filters = 'TaskTypeName eq \"DataClassification and EndBeforeTime eq 1762240800' # str | 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) # str | 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 # int | 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) # int | 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 # int | 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) # int | 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 = False # bool | 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) # bool | 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)

    try:
        # Lists all DAS tasks.
        
        results = DataAccessSecurityApi(api_client).get_tasks_v1()
        # Below is a request that includes all optional parameters
        # results = DataAccessSecurityApi(api_client).get_tasks_v1(filters, limit, offset, count)
        print("The response of DataAccessSecurityApi->get_tasks_v1:\n")
        for item in results:
            print(item.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->get_tasks_v1: %s\n" % e)

[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

Param Type	Name	Data Type	Required	Description
Query	filters	str	(optional)	Filter 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
Query	limit	int	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	offset	int	(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	bool	(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

List[Identitycollectorlistitem]

Responses

Code	Description	Data Type	Response headers
200	A list of identity collectors matching the filter criteria.	List[Identitycollectorlistitem]	* X-Total-Count - The total number of results matching the filter criteria, regardless of paging limits.
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.data_access_security.models.identitycollectorlistitem import Identitycollectorlistitem
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    filters = 'sourceId eq \"2c9180835d2e5168015d32f890ca1581\"' # str | 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) # str | 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)
    limit = 250 # int | 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) # int | 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 # int | 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) # int | 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 = False # bool | 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) # bool | 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)

    try:
        # List identity collectors
        
        results = DataAccessSecurityApi(api_client).list_identity_collectors_v1()
        # Below is a request that includes all optional parameters
        # results = DataAccessSecurityApi(api_client).list_identity_collectors_v1(filters, limit, offset, count)
        print("The response of DataAccessSecurityApi->list_identity_collectors_v1:\n")
        for item in results:
            print(item.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->list_identity_collectors_v1: %s\n" % e)

[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

Param Type	Name	Data Type	Required	Description
Path	id	int	True	The unique identifier of the application to update.
Body	basecreateapplicationrequest	Basecreateapplicationrequest	True	Request body containing the updated details for the application.

Return type

(empty response body)

Responses

Code	Description	Data Type	Response headers
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.data_access_security.models.basecreateapplicationrequest import Basecreateapplicationrequest
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    id = 12345 # int | The unique identifier of the application to update. # int | The unique identifier of the application to update.
    basecreateapplicationrequest = '''sailpoint.data_access_security.Basecreateapplicationrequest()''' # Basecreateapplicationrequest | Request body containing the updated details for the application.

    try:
        # Update application by identifier.
        new_basecreateapplicationrequest = Basecreateapplicationrequest.from_json(basecreateapplicationrequest)
        DataAccessSecurityApi(api_client).put_application_v1(id=id, basecreateapplicationrequest=new_basecreateapplicationrequest)
        # Below is a request that includes all optional parameters
        # DataAccessSecurityApi(api_client).put_application_v1(id, new_basecreateapplicationrequest)
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->put_application_v1: %s\n" % e)

[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

Param Type	Name	Data Type	Required	Description
Path	id	int	True	The unique identifier of the identity collector to update.
Body	updateidentitycollectorrequest	Updateidentitycollectorrequest	True	Request body containing the updated details for the identity collector.

Return type

(empty response body)

Responses

Code	Description	Data Type	Response headers
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.	GetTasksV1401Response	-
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	-
409	Conflict - Returned if an identity collector with the same name already exists.	PutIdentityCollectorV1409Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.data_access_security.models.updateidentitycollectorrequest import Updateidentitycollectorrequest
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    id = 12345 # int | The unique identifier of the identity collector to update. # int | The unique identifier of the identity collector to update.
    updateidentitycollectorrequest = '''sailpoint.data_access_security.Updateidentitycollectorrequest()''' # Updateidentitycollectorrequest | Request body containing the updated details for the identity collector.

    try:
        # Update identity collector by identifier
        new_updateidentitycollectorrequest = Updateidentitycollectorrequest.from_json(updateidentitycollectorrequest)
        DataAccessSecurityApi(api_client).put_identity_collector_v1(id=id, updateidentitycollectorrequest=new_updateidentitycollectorrequest)
        # Below is a request that includes all optional parameters
        # DataAccessSecurityApi(api_client).put_identity_collector_v1(id, new_updateidentitycollectorrequest)
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->put_identity_collector_v1: %s\n" % e)

[Back to top]

put-schedule-v1

Update a schedule.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	id	int	True	The unique identifier of the schedule to update.
Body	updateschedulerequest	Updateschedulerequest	True

Return type

(empty response body)

Responses

Code	Description	Data Type	Response headers
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.data_access_security.models.updateschedulerequest import Updateschedulerequest
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    id = 1001 # int | The unique identifier of the schedule to update. # int | The unique identifier of the schedule to update.
    updateschedulerequest = '''sailpoint.data_access_security.Updateschedulerequest()''' # Updateschedulerequest | 

    try:
        # Update a schedule.
        new_updateschedulerequest = Updateschedulerequest.from_json(updateschedulerequest)
        DataAccessSecurityApi(api_client).put_schedule_v1(id=id, updateschedulerequest=new_updateschedulerequest)
        # Below is a request that includes all optional parameters
        # DataAccessSecurityApi(api_client).put_schedule_v1(id, new_updateschedulerequest)
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->put_schedule_v1: %s\n" % e)

[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

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

Return type

(empty response body)

Responses

Code	Description	Data Type	Response headers
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.	GetTasksV1401Response	-
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.	GetTasksV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

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

Example

from sailpoint.data_access_security.api.data_access_security_api import DataAccessSecurityApi
from sailpoint.data_access_security.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    id = 1001 # int | The unique identifier of the task to rerun. # int | The unique identifier of the task to rerun.

    try:
        # Rerun a DAS task.
        
        DataAccessSecurityApi(api_client).start_task_rerun_v1(id=id)
        # Below is a request that includes all optional parameters
        # DataAccessSecurityApi(api_client).start_task_rerun_v1(id)
    except Exception as e:
        print("Exception when calling DataAccessSecurityApi->start_task_rerun_v1: %s\n" % e)

[Back to top]